X-Git-Url: https://jasonwoof.com/gitweb/?a=blobdiff_plain;ds=sidebyside;f=README.md;h=d2acc77d3e83be6fd445d9ecff0760a31682c9b2;hb=9ecc7f55f96de835055fa7c82f66d08b7b884a36;hp=111cd5df1155073705b1d9024102d41c45f44f66;hpb=0c9099629992eca837582bf019c54e9efd8a7f21;p=peach-html5-editor.git diff --git a/README.md b/README.md index 111cd5d..d2acc77 100644 --- 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 ------------------------