X-Git-Url: https://harishankar.org/repos/?p=wordblah.git;a=blobdiff_plain;f=README.html;h=9f3b974170e275375d3b276c18b6456c40acc939;hp=26c1acae4aa8f4a4d2d606e2c61468d699039445;hb=HEAD;hpb=6e6fdacc296dc237dc2da27c7d880dde1ee4e5ba
diff --git a/README.html b/README.html
index 26c1aca..9f3b974 100644
--- a/README.html
+++ b/README.html
@@ -23,9 +23,55 @@
To compile the source, simply run make inside the source directory.
Requirements
+ - Linux or UNIX-like OS
+ - clang - C compiler and GNU make.
- libgd devel (available on most *nix)
- zlib devel (available on most *nix)
- libcrypto devel files (available on most *nix)
+ - libgtk-3 devel files (for the player application)
+ - pkg-config (for GTK)
+ 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 wordblah and wordblah_player
+ should be created in the source directory.
+ Usage
+ Creating a puzzle
+ To run the creator application just run ./wordblah from the command line from within the directory
+ where the executable resides. (to run the player application the executable is wordblah_player.)
+ Command line options
+ To open an existing puzzle file
+ ./wordblah <filename>
+ To create a new puzzle file
+ ./wordblah <filename> new <gridsize>
+ Where gridsize is any number less than the maximum allowed size. Warning: using new will
+ overwrite any existing file without warning once you save!
+ Notes
+
+ - First create a new puzzle from the wordblah main menu if you haven't already invoked the command line
+ arguments to create/open a file. Choose an appropriate grid size - this cannot be changed later!
+ - Add words across and down. Note that, any letter that crosses any other word will overwrite existing cells without warning.
+ This is deliberate to keep building the puzzle simple and without too many prompts. You can always make modifications to
+ the puzzle until you are satisfied.
+ - Once satisfied with your grid, choose "Freeze grid" from the menu. This will black out unused grid cells and also number the
+ across and down words. Now you are ready to add the clues. Once a grid is frozen, you cannot add any further words to make
+ changes to existing words. To make changes to words in frozen grids, first unfreeze the grid by choosing "Unfreeze grid".
+ Warning: Unfreezing a frozen grid will remove all the word clues once you save and reload the file - this is because
+ unfreezing potentially changes the entire grid, including the list of words and word positions.
+ - Add clues for all the words. From "Set Clue - Across Word" and "Set Clue - Down Word" from the menu. Remember to save the
+ puzzle from time to time! You can only add clues in frozen grids
+ - You may want to optionally password protect the puzzle from being unauthorizedly edited by setting the master password.
+ Choose the menu "Set master (editing) password" from the menu.
+ - You may also want to optionally protect the solution from being revealed in the player application when the user clicks on
+ View -> Reveal Solution menu item. Choose "Set solution password" to set the password to protect the solution from
+ being revaled in the player.
+ - 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).
+ - Save and quit.
+ - Only frozen puzzles can be opened and played with the player application. Unfrozen puzzles are incomplete, hence cannot
+ be played.
+
+ License
+ Copyright © 2020 V.Harishankar (http://harishankar.org)
+ This software is released under the 3-clause BSD license. Read LICENSE.txt for more information.