File	Date	Author	Commit
doc	2010-09-19	Joni Toivanen	[bf731b] Minor fixes to man page.
.gitignore	2010-09-14	Joni Toivanen	[c2f410] Initial commit.
HACKING.txt	2010-09-14	Joni Toivanen	[c2f410] Initial commit.
README.txt	2010-09-18	Joni Toivanen	[0bf78e] Updated documentation for upcoming 0.3.
anagramm.c	2010-09-18	Joni Toivanen	[fb044c] Support for configuration files.
anagramm.conf	2010-09-18	Joni Toivanen	[0b007d] Added configuration file parser.
anagramm.h	2010-09-19	Joni Toivanen	[d9a35f] Bumped version to 0.3.
config.c	2010-09-18	Joni Toivanen	[df28e7] Fixed bugs in config module.
config.h	2010-09-18	Joni Toivanen	[df28e7] Fixed bugs in config module.
license.txt	2010-09-19	Joni Toivanen	[d9a35f] Bumped version to 0.3.
makefile	2010-09-19	Joni Toivanen	[d9a35f] Bumped version to 0.3.
wc.c	2010-09-16	Joni Toivanen	[d8dda3] Renamed LOCALIZE macro to USE_WCHAR.
wc.h	2010-09-16	Joni Toivanen	[d8dda3] Renamed LOCALIZE macro to USE_WCHAR.

Read Me

anagramm
========

`anagramm' is a command line tool for generating anagrams. It is
written in C and should work on most Unix-like systems (any
incompatibilities are most likely bugs).

Please note that `anagramm' is in very early stage of development and
bugs may abound!

See also the `HACKING.txt' file, if you want to make changes to the
program.


Compiling and Installing
------------------------
To compile `anagramm', you need a C compiler and a `make' utility. If
you also want to build the manual page, you need `AsciiDoc' and some
utility to generate a man page from DocBook XML -- `docbook2x-man' is
the default, but something like `xmlto' should also work, provided that
you change `doc/makefile'.

You should use the provided `makefile' to compile, if possible. To use
the default options, simply invoke make without any parameters:

    make

This will compile the program to use the default dictionary at
`/usr/share/dict/words'. If you want to use another dictionary, change
the value of the `DICT' variable in the makefile.

It is also possible to control whether to support wide-characters and
different encodings. These are enabled by default, but if you want a
build that only supports single-byte encodings, you can do so with:

    make USE_WCHAR=0

This also disables support for character set conversions with iconv.

The `makefile' can also be used to install the program:

    make install

(Note that this will most likely require root privileges!)

This will install the program to `/usr/local' and it will also compile
and install the documentation (currently just a man page). If you want
to install to some other directory (such as `/usr'), you can set the
`DESTDIR' parameter:

    make DESTDIR=/usr install

Similarly, you can uninstall the program with:

    make uninstall

or, if you used some other `DESTDIR' than the default, you should give
the `DESTDIR' parameter to uninstall too:

    make DESTDIR=/usr uninstall


Getting a Dictionary
--------------------
`anagramm' requires a dictionary to work. If you don't already have
one, you can try searching for a `wordlist' package in your package
manager. Or, if you use a system without package manager, you can try
the Internet.

Any dictionary that is just a list of words (one word per line!) should
work. Character encodings are supported through `iconv', and `anagramm'
should be able to translate encodings on the fly (as long as you set the
correct dictionary encoding with -E option).


Usage
-----
See the manual page `doc/anagramm.1.txt' for details on the program's
usage.


Bugs
----
There are no known bugs in `anagramm', and if you notice any, please
report them to the author (see next section), but the current release
does lack some important features, the lack of which may be considered
bugs:

* characters cannot be `grouped': anagramm considers every
different character a different letter (with the exception of case
differences). For some languages it would be useful to be able to group
characters, so that, for example, `a' and `à' would be considered the
same letter.

These features will be added in later releases.


Author
------
anagramm was written by Joni Toivanen, <jomiolto@gmail.com>


Copyright
---------
Copyright (c) 2010 Joni Toivanen. All rights reserved.
anagramm is released under the terms of the two-clause BSD license.
The full license text can be found in the provided `license.txt' file.