From: Jason Woofenden <jason@jasonwoof.com>
Date: Mon, 21 Dec 2015 02:24:30 +0000 (-0500)
Subject: add README.md
X-Git-Url: https://jasonwoof.com/gitweb/?p=peach-html5-editor.git;a=commitdiff_plain;h=cf969645829968285a2cd1f8bc6b8bc49822d0ea

add README.md
---

diff --git a/README.md b/README.md
new file mode 100644
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