From: Harishankar <v.harishankar@gmail.com>
Date: Mon, 11 May 2020 07:31:13 +0000 (+0530)
Subject: Updated the README.html file
X-Git-Tag: 0.1a
X-Git-Url: https://harishankar.org/repos/?a=commitdiff_plain;h=1bd4378ba9786810ff7f53adf8ddb52f42e79346;p=wordblah.git

Updated the README.html file
Updated the README file with more information
---

diff --git a/README.html b/README.html
index 35f8645..9f3b974 100644
--- a/README.html
+++ b/README.html
@@ -23,12 +23,17 @@
 	<p>To compile the source, simply run <code>make</code> inside the source directory.</p>
 	<p>Requirements</p>
 	<ul>
-		<li><a href="https://clang.llvm.org/">clang</a> - C compiler and GNU <a href="https://www.gnu.org/software/make/">make</a>.
-		You could also edit the Makefile to use <code>gcc</code> instead of clang if you so wish.</li>
+		<li>Linux or UNIX-like OS</li>
+		<li><a href="https://clang.llvm.org/">clang</a> - C compiler and GNU <a href="https://www.gnu.org/software/make/">make</a>.</li>
 		<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>
+		<li><a href="https://www.gtk.org/">libgtk-3</a> devel files (for the player application)</li>
+		<li><a href="pkg-config">pkg-config</a> (for GTK)</li>
 	</ul>
+	<p>The above dependencies would be installable using your distribution's package manager. Check your distribution software
+	repositories for more information. If everything went well, two executables <code>wordblah</code> and <code>wordblah_player</code>
+	should be created in the source directory.</p>
 	<h2>Usage</h2>
 	<h3>Creating a puzzle</h3>
 	<p>To run the creator application just run <code>./wordblah</code> from the command line from within the directory
@@ -59,9 +64,14 @@
 		<li>You may also want to optionally protect the solution from being revealed in the player application when the user clicks on
 		<i>View -> Reveal Solution</i> menu item.	Choose "Set solution password" to set the password to protect the solution from 
 		being revaled in the player.</li>
+		<li>Both master and solution password can be reset to no password by simply choosing the above options and not typing any
+		password (simply press enter for a blank passowrd).</li>
 		<li>Save and quit.</li>
 		<li>Only frozen puzzles can be opened and played with the player application. Unfrozen puzzles are incomplete, hence cannot 
 		be played.</li>
-	</ul>	
+	</ul>
+	<h2>License</h2>
+	<p>Copyright &copy; 2020 V.Harishankar (<a href="http://harishankar.org">http://harishankar.org</a>)</p>
+	<p>This software is released under the 3-clause BSD license. Read LICENSE.txt for more information.</p>
 </body>
 </html>
\ No newline at end of file