nsuds - The Ncurses Sudoku System
*********************************
. Version: nsuds-0.7B (Beta release)
. Written by Vincent Launchbury
. See AUTHORS for a complete list of contributors
. Report bugs to: <vincent@doublecreations.com>

INTRODUCTION
============
The nsuds project is a text graphical sudoku game with pencil-marking support.
The point of the project is to provide a portable implementation of sudoku with
the minimum possible dependencies. The only library dependency is ncurses,
although regular curses should surfice in it's place.


ADDITIONAL DOCUMENTATION
========================
AUTHORS           - A list of authors and contributors
COPYING           - License for this software (GPL V2)
ChangeLog         - A complete changelog, for developers
INSTALL           - Detailed generic install instructions
NEWS              - A basic changelog, for users

Project Website : Not yet up
Sourceforge site: http://www.sourceforge.net/projects/nsuds/
Git Repository  : http://nsuds.git.sourceforge.net/git/gitweb.cgi?p=nsuds/nsuds  

For help on how to use nsuds, press '?' in game.


COMPILING AND INSTALLING ON *NIX
================================
Packages for *NIX aren't currently provided. You could always ask your distros
development team to add nsuds to their repositories, if you don't like compiling
yourself. 

To extract the source code, fire up a terminal, cd into your download directory
and type the following commands:
   $tar xzf nsuds-0.7B.tar.gz
   $cd nsuds-0.7B

Then, to compile and install, run the following commands:
   $./configure
   $make
   (Then, as root)
   #make install

You can then run nsuds from any terminal.

(Note: If you downloaded a git snapshot, you'll have to run '$autoreconf -i'
before running ./configure. You'll need autotools to do this, specifically the
autoconf, automake and libtool packages. If you downloaded a regular release,
this doesn't apply to you.)


REMOVING NSUDS
==============
To remove nsuds, cd to the source directory and type the following as root:
#make uninstall
Which will remove any added files. 


IN-GAME KEYS
============
Press '?' in-game for more detailed help.

q       - Quit
n       - New Game
p       - Pause Game
1-9     - Enter number in selected square
DEL/x   - Delete number (can't delete pre-inserted numbers)
wasd   \  
hjkl    \ - Move between squares 
Arrows  /
Click  /
(Below, the # character stands for a number in the range 1-9)
m + #   - Mark the current square with the number #
c + #   - Clear mark number # from the current square
C + #   - Clear all marks with number #, from all squares
r + #   - Reveal (highlight) all marks with the number #
R + #   - Same as above, but allows upto 3 numbers to be highlighted at the
         same time
r + 0   - Remove all highlighting

Press '?' in-game for more detailed help.

MARKS
=====
Marking squares in nsuds is similar to how you would put pencil marks on a real
sudoku. When you mark a square with 1, you are saying that 1 may belong in that
square, but it doesn't input the number in the square.  However, when you
reveal sqaures marked with 1, it will highlight all the squares that you
thought may contain a 1, and temporarily show a 1 in those squares. Squares
that actually do contain a 1 will also be highlighted, but they will be
underlined to distinguish them from marks. 


SUPPORTED OPERATING SYSTEMS
===========================
nsuds is currently in beta, but it has been confirmed to work on the following
platforms:
   . GNU/Linux: Gentoo
   . GNU/Linux: Ubuntu