Mercurial > public > m209

annotate README.rst @ 48:1e8affa8fc11

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Rename README.txt to README.rst so Bitbucket will render it (until we get a setup.py file).
author Brian Neal <bgneal@gmail.com>
date Wed, 03 Jul 2013 21:22:54 -0500
parents README.txt@3cf5bfe17f2e
children
rev   line source
bgneal@47 1 ====
bgneal@47 2 m209
bgneal@47 3 ====
bgneal@47 4 A historically accurate M-209 library written in Python 3
bgneal@47 5 ---------------------------------------------------------
bgneal@47 6
bgneal@47 7 :Author: Brian Neal <bgneal@gmail.com>
bgneal@47 8 :Version: 0.1
bgneal@47 9 :Date: July 4, 2013
bgneal@47 10 :Home Page: https://bitbucket.org/bgneal/m209/
bgneal@47 11 :License: MIT License (see LICENSE.txt)
bgneal@47 12 :Documentation: (coming soon)
bgneal@47 13 :Support: https://bitbucket.org/bgneal/m209/issues
bgneal@47 14
bgneal@47 15 The `M-209`_ is a mechanical cipher machine used by the US military during World
bgneal@47 16 War II and up to the Korean War. The M-209 is also known as the CSP-1500 by
bgneal@47 17 the US Navy. The M-209 is an example of a Hagelin device, a family of
bgneal@47 18 mechanical cipher machines created by Swedish inventor `Boris Hagelin`_.
bgneal@47 19
bgneal@47 20 This project is a Python 3 library and command-line utility for encrypting and
bgneal@47 21 decrypting text by simulating the operation of an actual M-209 device.
bgneal@47 22
bgneal@47 23 Please see the documentation (coming soon) for library usage, tutorials and
bgneal@47 24 references.
bgneal@47 25
bgneal@47 26
bgneal@47 27 .. _M-209: http://en.wikipedia.org/wiki/M-209
bgneal@47 28 .. _Boris Hagelin: http://en.wikipedia.org/wiki/Boris_Hagelin