README.md

   1 wheic
   2 =====
   3
   4 This project is to build a HTML5 parser, then use that to build a WYSIWYG html
   5 editor for the browser.
   6
   7 The code is written in CoffeeScript for modern browsers. The HTML5 parser can
   8 also run under node.js.
   9
  10
  11 Status
  12 ------
  13
  14 HTML5 parser: all (1581) tests pass. Works in the browser and node.js
  15
  16 WYSIWYG editor: planning stages
  17
  18
  19 Getting Started
  20 ---------------
  21
  22 Recommended: see "With CoffeeScript" below
  23
  24 (experimental) Alternate: see "Without Compiling"
  25
  26
  27 With CoffeeScript
  28 ------------------
  29
  30 You can get CoffeeScript with a command such as this:
  31
  32         apt-get install coffeescript
  33
  34 or
  35
  36         npm install -g coffee-script
  37
  38
  39 Then, to test in the browser, run ``make``, then open ``index.html`` in your
  40 favorite browser.
  41
  42 Or, to run the tests on the commandline, run ``coffee test.coffee``
  43
  44
  45 Without CoffeeScript
  46 -----------------
  47
  48 It is recommended to install CoffeeScript (see With CoffeeScript above), but it
  49 should be pretty easy to get your browser to compile the CoffeScript on the
  50 fly, to avoid installing anything. See the instructions here:
  51
  52         http://coffeescript.org/#scripts
  53
  54
  55 Feedback, Questions, Etc
  56 ------------------------
  57
  58 Please communicate directly with Jason Woofenden by email: jason@jasonwoof.com
  59 or on freenode /msg JasonWoof