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.
   8
   9
  10 Status
  11 ------
  12
  13 Under development
  14
  15
  16 Getting Started
  17 ---------------
  18
  19 Recommended: see "Compiling" below
  20
  21 (experimental) Alternate: see "Without Compiling"
  22
  23
  24 Compiling
  25 ---------
  26
  27 You'll need coffeescript, you can hopefully get that with a command such as
  28 this:
  29
  30         apt-get install coffeescript
  31
  32 or
  33
  34         npm install -g coffee-script
  35
  36 Then run ``make``
  37
  38 Then run the test suite by opening ``index.html`` in a modern browser.
  39
  40
  41 Without Compiling
  42 -----------------
  43
  44 It is recommended to install coffeescript (see Compiling above), but you might
  45 be able to got it to compile directly in the browser, see here:
  46
  47         http://coffeescript.org/#scripts
  48
  49 Please nudge Jason (see below) to make this easier.
  50
  51
  52 Feedback, Questions, Etc
  53 ------------------------
  54
  55 Please communicate directly with Jason Woofenden by email: jason@jasonwoof.com
  56 or on freenode /msg JasonWoof