Added README.html file
[wordblah.git] / README.html
diff --git a/README.html b/README.html
new file mode 100644 (file)
index 0000000..26c1aca
--- /dev/null
@@ -0,0 +1,31 @@
+<!DOCTYPE html>
+<html>
+<head>
+<meta charset="utf-8" />
+<title></title>
+</head>
+<body>
+       <h1>Wordblah Readme</h1>
+       <p>Wordblah is a crossword puzzle creator and maker written in C. The creator is a terminal application and 
+       the default player application is written in GTK.</p>
+       <h2>Features</h2>
+       <ol>
+               <li>Square grid upto 25x25 supported.</li>
+               <li>Add words across or down.</li>
+               <li>Automatic word numbering after grid is frozen.</li>
+               <li>Add word Clues.</li>        
+               <li>Export the puzzle and/or solution in PNG format.</li>
+               <li>Export the clues as a text file.</li>
+               <li>Password protect the puzzle for editing (master password)</li>
+               <li>Password protect viewing the solution (in the player application)</li>
+       </ol>
+       <h2>Compiling</h2>
+       <p>To compile the source, simply run <code>make</code> inside the source directory.</p>
+       <p>Requirements</p>
+       <ul>
+               <li><a href="https://libgd.github.io/">libgd</a> devel (available on most *nix)</li>
+               <li><a href="https://www.zlib.net/">zlib</a> devel (available on most *nix)</li>
+               <li><a href="https://www.openssl.org/">libcrypto</a> devel files (available on most *nix)</li>
+       </ul>
+</body>
+</html>
\ No newline at end of file