Mercurial > public > enigma

comparison README.txt @ 31:560ded21dcd9

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Cleaned up some awkward wording in the README.
author Brian Neal <bgneal@gmail.com>
date Wed, 30 May 2012 20:08:15 -0500
parents 62e0d0e2628b
children 360534b4781d
comparison
equal deleted inserted replaced
30:62e0d0e2628b 31:560ded21dcd9
13 13
14 14
15 Overview 15 Overview
16 -------- 16 --------
17 17
18 **Py-Enigma** is a Python 3 library for simulating the `Enigma machines`_ used by 18 **Py-Enigma** is a Python 3 library for simulating the `Enigma machines`_ used
19 the German armed forces (Wehrmacht) during World War 2. Py-Enigma makes it 19 by the German armed forces (Wehrmacht) during World War 2. Py-Enigma makes it
20 possible to both encrypt and decrypt messages that can be read by, or written 20 possible to both encrypt and decrypt messages that can be sent to, or received
21 to, actual Enigma machines used by the German army (Heer), air force 21 from, actual Enigma machines used by the German army (Heer), air force
22 (Luftwaffe), and navy (Kriegsmarine). 22 (Luftwaffe), and navy (Kriegsmarine).
23 23
24 It is my hope that library will be useful to Enigma enthusiasts, historians, and 24 It is my hope that library will be useful to Enigma enthusiasts, historians, and
25 students interested in cryptography. 25 students interested in cryptography.
26 26
113 113
114 Once you have obtained a copy of the source somehow, to install:: 114 Once you have obtained a copy of the source somehow, to install::
115 115
116 $ python setup.py install 116 $ python setup.py install
117 117
118
118 Documentation 119 Documentation
119 ------------- 120 -------------
120 121
121 I want to use Py-Enigma as a chance to learn Sphinx_, so you can expect to see 122 I want to use Py-Enigma as a chance to learn Sphinx_, so you can expect to see
122 some nicely formatted documentation coming soon. In the meantime, please read 123 some nicely formatted documentation coming soon. In the meantime, please read
123 the source code. I commented it heavily so I could understand how the Enigma 124 the source code. I commented it heavily so I could understand how the Enigma
124 machine works. 125 machine works.
126
125 127
126 Support 128 Support
127 ------- 129 -------
128 130
129 Support is provided at the `issue tracker`_ at the `Py-Enigma Bitbucket page`_. 131 Support is provided at the `issue tracker`_ at the `Py-Enigma Bitbucket page`_.