Mercurial > public > enigma

comparison README.txt @ 30:62e0d0e2628b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Created a setup.py using distutils.
author Brian Neal <bgneal@gmail.com>
date Wed, 30 May 2012 19:16:22 -0500
parents f8734f73baa8
children 560ded21dcd9
comparison
equal deleted inserted replaced
29:f8734f73baa8 30:62e0d0e2628b
3 ========= 3 =========
4 A historically accurate Enigma Machine library written in Python 3 4 A historically accurate Enigma Machine library written in Python 3
5 ------------------------------------------------------------------ 5 ------------------------------------------------------------------
6 6
7 :Author: Brian Neal <bgneal@gmail.com> 7 :Author: Brian Neal <bgneal@gmail.com>
8 :Version: 0.1 8 :Version: Alpha
9 :Date: May 28, 2012 9 :Date: May 30, 2012
10 :Home Page: https://bitbucket.org/bgneal/enigma/ 10 :Home Page: https://bitbucket.org/bgneal/enigma/
11 :License: MIT License (see LICENSE.txt) 11 :License: MIT License (see LICENSE.txt)
12 :Support: https://bitbucket.org/bgneal/enigma/issues 12 :Support: https://bitbucket.org/bgneal/enigma/issues
13 13
14 14
76 76
77 Py-Enigma also includes a command-line application for processing messages. 77 Py-Enigma also includes a command-line application for processing messages.
78 Assuming you have a proper key file that contains the same initial settings as 78 Assuming you have a proper key file that contains the same initial settings as
79 the code above, the above example can be performed on the command-line:: 79 the code above, the above example can be performed on the command-line::
80 80
81 $ pyenigma --key-file=keys.txt --start=WXC --text='KCH' 81 $ pyenigma.py --key-file=keys.txt --start=WXC --text='KCH'
82 BLA 82 BLA
83 $ pyenigma --key-file=keys.txt --start=BLA --text='NIBLFMYMLLUFWCASCSSNVHAZ' 83 $ pyenigma.py --key-file=keys.txt --start=BLA --text='NIBLFMYMLLUFWCASCSSNVHAZ'
84 THEXRUSSIANSXAREXCOMINGX 84 THEXRUSSIANSXAREXCOMINGX
85 85
86 The format of the key file can be found in the documentation. 86 The format of the key file can be found in the documentation.
87 87
88 88
89 Requirements 89 Requirements
90 ------------ 90 ------------
91 91
92 Py-Enigma is written in Python_, specifically Python 3. It has no other 92 Py-Enigma is written in Python_, specifically Python 3.2. It has no other
93 requirements or dependencies. 93 requirements or dependencies.
94 94
95 95
96 Project Status 96 Project Status
97 -------------- 97 --------------
109 page`_. Alternatively if you use Mercurial_, you can clone the repository with 109 page`_. Alternatively if you use Mercurial_, you can clone the repository with
110 the following command:: 110 the following command::
111 111
112 $ hg clone https://bitbucket.org/bgneal/enigma 112 $ hg clone https://bitbucket.org/bgneal/enigma
113 113
114 In the very near future I will provide a ``setup.py`` script that will allow you 114 Once you have obtained a copy of the source somehow, to install::
115 to install Py-Enigma. For the time being, just place the ``enigma`` directory on 115
116 your ``PYTHONPATH``. 116 $ python setup.py install
117 117
118 Documentation 118 Documentation
119 ------------- 119 -------------
120 120
121 I want to use Py-Enigma as a chance to learn Sphinx_, so you can expect to see 121 I want to use Py-Enigma as a chance to learn Sphinx_, so you can expect to see