Mercurial > public > m209
comparison README.txt @ 47:3cf5bfe17f2e
Finally created a README file.
author | Brian Neal <bgneal@gmail.com> |
---|---|
date | Wed, 03 Jul 2013 21:18:27 -0500 (2013-07-04) |
parents | |
children |
comparison
equal
deleted
inserted
replaced
46:56a2068c3c29 | 47:3cf5bfe17f2e |
---|---|
1 ==== | |
2 m209 | |
3 ==== | |
4 A historically accurate M-209 library written in Python 3 | |
5 --------------------------------------------------------- | |
6 | |
7 :Author: Brian Neal <bgneal@gmail.com> | |
8 :Version: 0.1 | |
9 :Date: July 4, 2013 | |
10 :Home Page: https://bitbucket.org/bgneal/m209/ | |
11 :License: MIT License (see LICENSE.txt) | |
12 :Documentation: (coming soon) | |
13 :Support: https://bitbucket.org/bgneal/m209/issues | |
14 | |
15 The `M-209`_ is a mechanical cipher machine used by the US military during World | |
16 War II and up to the Korean War. The M-209 is also known as the CSP-1500 by | |
17 the US Navy. The M-209 is an example of a Hagelin device, a family of | |
18 mechanical cipher machines created by Swedish inventor `Boris Hagelin`_. | |
19 | |
20 This project is a Python 3 library and command-line utility for encrypting and | |
21 decrypting text by simulating the operation of an actual M-209 device. | |
22 | |
23 Please see the documentation (coming soon) for library usage, tutorials and | |
24 references. | |
25 | |
26 | |
27 .. _M-209: http://en.wikipedia.org/wiki/M-209 | |
28 .. _Boris Hagelin: http://en.wikipedia.org/wiki/Boris_Hagelin |