From: Harishankar Date: Mon, 11 May 2020 06:23:26 +0000 (+0530) Subject: Added README.html file X-Git-Tag: 0.1a~2 X-Git-Url: https://harishankar.org/repos/?a=commitdiff_plain;h=43e0759b9de2a8f087b8a7301602dad7ed035b84;p=wordblah.git Added README.html file Added a README.html file - to be updated with more information --- diff --git a/README.html b/README.html new file mode 100644 index 0000000..49378e6 --- /dev/null +++ b/README.html @@ -0,0 +1,68 @@ + + + + + + + +

Wordblah Readme

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.

Features

Square grid upto 25x25 supported.
Add words across or down.
Automatic word numbering after grid is frozen.
Add word Clues.
Export the puzzle and/or solution in PNG format.
Export the clues as a text file.
Password protect the puzzle for editing (master password)
Password protect viewing the solution (in the player application)

Compiling

To compile the source, simply run make inside the source directory.

Requirements

clang - C compiler and GNU make. + You could also edit the Makefile to use gcc instead of clang if you so wish.
libgd devel (available on most *nix)
zlib devel (available on most *nix)
libcrypto devel files (available on most *nix)

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.
Save and quit.
Only frozen puzzles can be opened and played with the player application. Unfrozen puzzles are incomplete, hence cannot + be played.

+ + + \ No newline at end of file