improve docs

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

diff --git a/README.md b/README.md
index 111cd5d..d2acc77 100644 (file)
--- a/README.md
+++ b/README.md
@@ -4,6 +4,9 @@ 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.
+
+
 Status
 ------
 
@@ -13,6 +16,14 @@ Under development
 Getting Started
 ---------------
 
+Recommended: see "Compiling" below
+
+(experimental) Alternate: see "Without Compiling"
+
+
+Compiling
+---------
+
 You'll need coffeescript, you can hopefully get that with a command such as
 this:
 
@@ -27,6 +38,17 @@ Then run ``make``
 Then run the test suite by opening ``index.html`` in a modern browser.
 
 
+Without Compiling
+-----------------
+
+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:
+
+       http://coffeescript.org/#scripts
+
+Please nudge Jason (see below) to make this easier.
+
+
 Feedback, Questions, Etc
 ------------------------