Got questions, comments, patches, etc.?
Contact Jason Woofenden
gitweb
/
peach-html5-editor.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
update comments
[peach-html5-editor.git]
/
README.md
diff --git
a/README.md
b/README.md
index
d2acc77
..
8f86eec
100644
(file)
--- a/
README.md
+++ b/
README.md
@@
-4,28
+4,30
@@
wheic
This project is to build a HTML5 parser, then use that to build a WYSIWYG html
editor for the browser.
This project is to build a HTML5 parser, then use that to build a WYSIWYG html
editor for the browser.
-The code is written in coffeescript for modern browsers.
+The code is written in CoffeeScript for modern browsers. The HTML5 parser can
+also run under node.js.
Status
------
Status
------
-Under development
+HTML5 parser: all (1581) tests pass. Works in the browser and node.js
+
+WYSIWYG editor: planning stages
Getting Started
---------------
Getting Started
---------------
-Recommended: see "Compiling" below
+Recommended: see "With CoffeeScript" below
(experimental) Alternate: see "Without Compiling"
(experimental) Alternate: see "Without Compiling"
-Compiling
----------
+With CoffeeScript
+------------------
-You'll need coffeescript, you can hopefully get that with a command such as
-this:
+You can get CoffeeScript with a command such as this:
apt-get install coffeescript
apt-get install coffeescript
@@
-33,21
+35,22
@@
or
npm install -g coffee-script
npm install -g coffee-script
-Then run ``make``
-Then run the test suite by opening ``index.html`` in a modern browser.
+Then, to test in the browser, run ``make``, then open ``index.html`` in your
+favorite browser.
+
+Or, to run the tests on the commandline, run ``coffee test.coffee``
-Without Compiling
+Without CoffeeScript
-----------------
-----------------
-It is recommended to install coffeescript (see Compiling above), but you might
-be able to got it to compile directly in the browser, see here:
+It is recommended to install CoffeeScript (see With CoffeeScript above), but it
+should be pretty easy to get your browser to compile the CoffeScript on the
+fly, to avoid installing anything. See the instructions here:
http://coffeescript.org/#scripts
http://coffeescript.org/#scripts
-Please nudge Jason (see below) to make this easier.
-
Feedback, Questions, Etc
------------------------
Feedback, Questions, Etc
------------------------