update comments

[peach-html5-editor.git] / README.md

diff --git a/README.md b/README.md
index 111cd5d..8f86eec 100644 (file)
--- a/README.md
+++ b/README.md
@@ -4,17 +4,30 @@ wheic
 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 HTML5 parser can
+also run under node.js.
+
+
 Status
 ------
 
-Under development
+HTML5 parser: all (1581) tests pass. Works in the browser and node.js
+
+WYSIWYG editor: planning stages
 
 
 Getting Started
 ---------------
 
-You'll need coffeescript, you can hopefully get that with a command such as
-this:
+Recommended: see "With CoffeeScript" below
+
+(experimental) Alternate: see "Without Compiling"
+
+
+With CoffeeScript
+------------------
+
+You can get CoffeeScript with a command such as this:
 
        apt-get install coffeescript
 
@@ -22,9 +35,21 @@ or
 
        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 CoffeeScript
+-----------------
+
+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
 
 
 Feedback, Questions, Etc