JasonWoof Got questions, comments, patches, etc.? Contact Jason Woofenden
add README.md
authorJason Woofenden <jason@jasonwoof.com>
Mon, 21 Dec 2015 02:24:30 +0000 (21:24 -0500)
committerJason Woofenden <jason@jasonwoof.com>
Mon, 21 Dec 2015 02:24:30 +0000 (21:24 -0500)
README.md [new file with mode: 0644]

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..111cd5d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,34 @@
+wheic
+=====
+
+This project is to build a HTML5 parser, then use that to build a WYSIWYG html
+editor for the browser.
+
+Status
+------
+
+Under development
+
+
+Getting Started
+---------------
+
+You'll need coffeescript, you can hopefully get that with a command such as
+this:
+
+       apt-get install coffeescript
+
+or
+
+       npm install -g coffee-script
+
+Then run ``make``
+
+Then run the test suite by opening ``index.html`` in a modern browser.
+
+
+Feedback, Questions, Etc
+------------------------
+
+Please communicate directly with Jason Woofenden by email: jason@jasonwoof.com
+or on freenode /msg JasonWoof