view README.txt @ 65:256b3f3e35e9

Add M209 class docs.
author Brian Neal <bgneal@gmail.com>
date Sat, 20 Jul 2013 18:52:45 -0500
parents 41df1e5308e9
children
line wrap: on
line source
====
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: https://m209.readthedocs.org
: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_ for library usage, tutorials and
references.


.. _M-209: http://en.wikipedia.org/wiki/M-209
.. _Boris Hagelin: http://en.wikipedia.org/wiki/Boris_Hagelin
.. _documentation: https://m209.readthedocs.org