Mercurial > public > m209

comparison README.txt @ 53:41df1e5308e9

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update README.txt with documentation links.
author Brian Neal <bgneal@gmail.com>
date Thu, 04 Jul 2013 23:02:42 -0500
parents 2eca19f50fdb
children
comparison
equal deleted inserted replaced
52:5b335e8af407 53:41df1e5308e9
7 :Author: Brian Neal <bgneal@gmail.com> 7 :Author: Brian Neal <bgneal@gmail.com>
8 :Version: 0.1 8 :Version: 0.1
9 :Date: July 4, 2013 9 :Date: July 4, 2013
10 :Home Page: https://bitbucket.org/bgneal/m209/ 10 :Home Page: https://bitbucket.org/bgneal/m209/
11 :License: MIT License (see LICENSE.txt) 11 :License: MIT License (see LICENSE.txt)
12 :Documentation: (coming soon) 12 :Documentation: https://m209.readthedocs.org
13 :Support: https://bitbucket.org/bgneal/m209/issues 13 :Support: https://bitbucket.org/bgneal/m209/issues
14 14
15 The `M-209`_ is a mechanical cipher machine used by the US military during World 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 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 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`_. 18 mechanical cipher machines created by Swedish inventor `Boris Hagelin`_.
19 19
20 This project is a Python 3 library and command-line utility for encrypting and 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. 21 decrypting text by simulating the operation of an actual M-209 device.
22 22
23 Please see the documentation (coming soon) for library usage, tutorials and 23 Please see the documentation_ for library usage, tutorials and
24 references. 24 references.
25 25
26 26
27 .. _M-209: http://en.wikipedia.org/wiki/M-209 27 .. _M-209: http://en.wikipedia.org/wiki/M-209
28 .. _Boris Hagelin: http://en.wikipedia.org/wiki/Boris_Hagelin 28 .. _Boris Hagelin: http://en.wikipedia.org/wiki/Boris_Hagelin
29 .. _documentation: https://m209.readthedocs.org