Added README.html file
[wordblah.git] / README.html
1 <!DOCTYPE html>
2 <html>
3 <head>
4 <meta charset="utf-8" />
5 <title></title>
6 </head>
7 <body>
8 <h1>Wordblah Readme</h1>
9 <p>Wordblah is a crossword puzzle creator and maker written in C. The creator is a terminal application and
10 the default player application is written in GTK.</p>
11 <h2>Features</h2>
12 <ol>
13 <li>Square grid upto 25x25 supported.</li>
14 <li>Add words across or down.</li>
15 <li>Automatic word numbering after grid is frozen.</li>
16 <li>Add word Clues.</li>
17 <li>Export the puzzle and/or solution in PNG format.</li>
18 <li>Export the clues as a text file.</li>
19 <li>Password protect the puzzle for editing (master password)</li>
20 <li>Password protect viewing the solution (in the player application)</li>
21 </ol>
22 <h2>Compiling</h2>
23 <p>To compile the source, simply run <code>make</code> inside the source directory.</p>
24 <p>Requirements</p>
25 <ul>
26 <li><a href="https://libgd.github.io/">libgd</a> devel (available on most *nix)</li>
27 <li><a href="https://www.zlib.net/">zlib</a> devel (available on most *nix)</li>
28 <li><a href="https://www.openssl.org/">libcrypto</a> devel files (available on most *nix)</li>
29 </ul>
30 </body>
31 </html>