aenig4 - Enigma M4 Cipher Machine Emulator
==========================================

`aenig4` emulates the Enigma M4 cipher machine used by the U-boot division of
the German Navy during World War II. It can be used as well to emulate the
Enigma I machine (M1, M2, M3).

For more info about the machine, see:
http://cryptomuseum.com/crypto/enigma/m4/index.htm

aenig4 is free software. See the file `COPYING` for copying conditions.

Home page: https://jorgicor.niobe.org/aenig4  
GitHub: https://github.com/jorgicor/aenig4
Send bug reports to: jorge.giner@hotmail.com

Windows precompiled binaries
============================

A precompiled distribution for *Microsoft Windows* is provided in a ZIP file.
It can be found at https://jorgicor.niobe.org/aenig4 . After decompressing it,
you will have these files:

~~~
aenig4.exe      The program.
aenig4.html     Manual.
readme.txt      This file.
copying.txt     License.
news.txt	What's new in this version.
~~~

Compiling
=========

Getting the code from revision control
--------------------------------------

If you cloned the project from a revision control system (i.e. GitHub), you
will need first to use the GNU autotools to generate some files, in particular,
the `configure` script. Use:

    $ ./bootstrap

to generate the required files. You will need *GNU autoconf*, *GNU automake*
and *help2man*.

Compiling from the source distribution
--------------------------------------

If you have the official source package, and you are building on a Unix
environment (this includes *Cygwin* on *Windows*), you can find detailed
instructions in the file `INSTALL`. The complete source distribution can always
be found at https://jorgicor.niobe.org/aenig4 .  

After installing, you can type `man aenig4` to see a brief explanation on how
to use the `aenig4` program.

Normally, after installing from source, you can find this on your system:

~~~
/usr/local/bin/aenig4                    The program executable.
/usr/local/share/man/man1/aenig4.1       The manual page.
/usr/local/share/doc/aenig4/COPYING      License.
/usr/local/share/doc/aenig4/README       This file.
/usr/local/share/doc/aenig4/NEWS         What's new in this version.
/usr/local/share/doc/aenig4/INSTALL      How compile, install and uninstall.
/usr/local/share/doc/aenig4/AUTHORS      Authors.
~~~

If you are installing aenig4 using your OS distribution package system, these
folders will probably be different. Try changing `/usr/local` to `/usr`.

