Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

First draft of README file

  • Loading branch information...
commit e26d7567844ea2120452a157167a1092f7ce3e3e 1 parent 62eba8d
@glguy authored
Showing with 34 additions and 0 deletions.
  1. +34 −0 README.md
View
34 README.md
@@ -0,0 +1,34 @@
+Description
+===========
+
+The vty-hangman-helper tool is designed to help
+you solve Hanging With Friends puzzles and to explore
+how difficult words you choose will be.
+
+Installation
+============
+
+Install the Haskell Platform and use the cabal-install
+tool to install this program.
+
+$ cabal install
+
+Usage
+=====
+
+Use the -s flag to automatically hide all letters
+except the last vowel.
+
+Use the -f flag to select your own word list.
+
+When specifying the starting mask, use '.' for unknown
+letters.
+
+vty-hangman-helper \[-s] [-f FILENAME] STARTING\_WORD
+
+Examples
+========
+
+$ vty-hangman-helper .a...a.
+
+$ vty-hangman-helper -s hangman
Please sign in to comment.
Something went wrong with that request. Please try again.