Mercurial > public > m209
diff README.txt @ 47:3cf5bfe17f2e
Finally created a README file.
author | Brian Neal <bgneal@gmail.com> |
---|---|
date | Wed, 03 Jul 2013 21:18:27 -0500 |
parents | |
children |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/README.txt Wed Jul 03 21:18:27 2013 -0500 @@ -0,0 +1,28 @@ +==== +m209 +==== +A historically accurate M-209 library written in Python 3 +--------------------------------------------------------- + +:Author: Brian Neal <bgneal@gmail.com> +:Version: 0.1 +:Date: July 4, 2013 +:Home Page: https://bitbucket.org/bgneal/m209/ +:License: MIT License (see LICENSE.txt) +:Documentation: (coming soon) +:Support: https://bitbucket.org/bgneal/m209/issues + +The `M-209`_ is a mechanical cipher machine used by the US military during World +War II and up to the Korean War. The M-209 is also known as the CSP-1500 by +the US Navy. The M-209 is an example of a Hagelin device, a family of +mechanical cipher machines created by Swedish inventor `Boris Hagelin`_. + +This project is a Python 3 library and command-line utility for encrypting and +decrypting text by simulating the operation of an actual M-209 device. + +Please see the documentation (coming soon) for library usage, tutorials and +references. + + +.. _M-209: http://en.wikipedia.org/wiki/M-209 +.. _Boris Hagelin: http://en.wikipedia.org/wiki/Boris_Hagelin