basic gameplay working

[hexbog.git] / README.txt

diff --git a/README.txt b/README.txt
new file mode 100644 (file)
index 0000000..5937717
--- /dev/null
+++ b/README.txt
@@ -0,0 +1,74 @@
+HexBog
+======
+
+HexBog is a word game.
+
+
+How To Play
+-----------
+
+Open index.html file in your browser. See "Installing" section below for
+creating this file.
+
+Click a series of contiguous letter tiles that form a word.
+
+Click the last letter in your word again and it will disappear, giving you
+points.
+
+To save, copy down the URL, or make a bookmark. (The web address is
+automatically to contain the game state each time you make a word.)
+
+
+Installing
+----------
+
+You'll need a few things to build HexBog:
+
++      A copy of jquery
++      The coffeescript compiler (coffee)
++      uglifyjs (unless you edit the Makefile)
++      A few basic shell commands (possibly the GNU variants): make, cat, head,
+       tail
+
+On debian (unstable as of this writing) you can get these prerequisites
+installed like so:
+
+       apt-get install coffeescript libjs-jquery node-uglify make
+
+And you'll need a wordlist. This is a file with one word per line, with unix
+newlines (just \n). Download or create such a file, and name it wordlist.txt
+and place it in this directory.
+
+Then run:
+
+       make
+
+That should minify and combine all the files for the game into one new file:
+index.html you can copy/move that file anywhere.
+
+See "How To Play" above.
+
+
+Feedback / Bugs / patches
+-------------------------
+
+Please send feedback, bugs, patches, etc to jason@jasonwoof.com
+
+
+Author
+------
+
+So far this is all written by Jason Woofenden.
+
+
+Licensing
+---------
+
+HexBog is freely available under the terms of the GNU AGPL 3+. See COPYING.txt
+for details.
+
+Once built, HexBog (index.html) contains a minified copy of jquery which is
+available under the GPL among other licenses.
+
+When you make a word, HexBog will attempt to download and display a definition
+from wiktionary.org. These definitions are CC-BY-SA.