From: Jason Woofenden <jason@jasonwoof.com>
Date: Sun, 20 Sep 2015 22:05:22 +0000 (-0400)
Subject: add README.md
X-Git-Url: https://jasonwoof.com/gitweb/?p=crayon_mockup.git;a=commitdiff_plain;h=0bcf01406ac0df78a1716049870ae5febd9d46b1;hp=2abc023e554a366c19c4d8717424cd3d02f6823a

add README.md
---

diff --git a/.gitignore b/.gitignore
index 5e5f776..a8920e4 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,2 +1,2 @@
-/auto.js
+/main.js
 /style.css
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5e80a9b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,49 @@
+About
+-----
+
+This is a tool to create design mockups in the browser.
+
+It is client-side only (just javascript and some CSS).
+
+The interface is SVG, so it works on everything except IE8.
+
+
+Status
+------
+
+Early development. Not ready to be used yet. Patches welcome.
+
+
+Hacking / Building
+------------------
+
+1.	Install prerequisites:
+
+		apt-get install make coffeescript node-stylus jquery javascript-common
+
+2.	Compile
+
+		make
+
+3.	Open this directory via some url that goes through apache or lighttpd
+
+
+See below if you don't have, or don't want to have javascript-common and Apache.
+
+
+Hacking / Building without apache and javascript-common
+-------------------------------------------------------
+
+1.	Install prerequisites:
+
+		apt-get install make coffeescript node-stylus
+
+2.	Compile
+
+		make
+
+3.	Download jquery
+
+4.	Edit the URL for jquery in index.html
+
+5.	Open index.html in your browser