README.txt

   1 HexBog
   2 ======
   3
   4 HexBog is a word game.
   5
   6
   7 How To Play
   8 -----------
   9
  10 Open index.html file in your browser. See "Installing" section below for
  11 creating this file.
  12
  13 Click a series of contiguous letter tiles that form a word.
  14
  15 Click the last letter in your word again and it will disappear, giving you
  16 points.
  17
  18 To save, copy down the URL, or make a bookmark. (The web address is
  19 automatically updated to contain the game state each time you make a word.)
  20
  21
  22 Installing
  23 ----------
  24
  25 You'll need a few things to build HexBog:
  26
  27 +       A copy of jquery
  28 +       The coffeescript compiler (coffee)
  29 +       uglifyjs (unless you edit the Makefile)
  30 +       A few basic shell commands (possibly the GNU variants): make, cat, head,
  31         tail
  32
  33 On debian (unstable as of this writing) you can get these prerequisites
  34 installed like so:
  35
  36         apt-get install coffeescript libjs-jquery node-uglify node-less make
  37
  38 And you'll need a word list. This is a file with one word per line, with unix
  39 newlines (just LF). Download or create such a file, and name it wordlist.txt
  40 and place it in this directory.
  41
  42 Then run:
  43
  44         make
  45
  46 That should minify and combine all the files for the game into one new file:
  47 index.html you can copy/move that file anywhere.
  48
  49 See "How To Play" above.
  50
  51
  52 Feedback / Bugs / patches
  53 -------------------------
  54
  55 Please send feedback, bugs, patches, etc to jason@jasonwoof.com
  56
  57
  58 Author
  59 ------
  60
  61 So far this is all written by Jason Woofenden.
  62
  63
  64 Licensing
  65 ---------
  66
  67 HexBog is freely available under the terms of the GNU AGPL 3+. See COPYING.txt
  68 for details.
  69
  70 Once built, HexBog (index.html) contains a minified copy of jquery which is
  71 available under the GPL among other licenses.
  72
  73 When you make a word, HexBog will attempt to download and display a definition
  74 from wiktionary.org. These definitions are CC-BY-SA.