Mercurial > public > enigma

comparison README.txt @ 46:ad9d606ef5fa

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Updates for upload to PyPI.
author Brian Neal <bgneal@gmail.com>
date Tue, 05 Jun 2012 19:03:36 -0500
parents 19d33ff901af
children
comparison
equal deleted inserted replaced
45:19d33ff901af 46:ad9d606ef5fa
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: 0.1
9 :Date: June 4, 2012 9 :Date: June 5, 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 :Documentation: http://py-enigma.readthedocs.org/ 12 :Documentation: http://py-enigma.readthedocs.org/
13 :Support: https://bitbucket.org/bgneal/enigma/issues 13 :Support: https://bitbucket.org/bgneal/enigma/issues
14 14
95 95
96 96
97 Installation 97 Installation
98 ------------ 98 ------------
99 99
100 After the project gets a bit more mature I will add Py-Enigma to the `Python 100 Py-Enigma is available on the `Python Package Index`_ (PyPI). You can install it
101 Package Index`_ (PyPI). In the meantime, you may download a tarball or .zip file 101 using pip_::
102 of the latest code using the "get source" link on the `Py-Enigma Bitbucket 102
103 page`_. Alternatively if you use Mercurial_, you can clone the repository with 103 $ pip install py-enigma # install
104 the following command:: 104 $ pip install --upgrade py-enigma # upgrade
105
106 You may also download a tarball or .zip file of the latest code using the "get
107 source" link on the `Py-Enigma Bitbucket page`_. Alternatively if you use
108 Mercurial_, you can clone the repository with the following command::
105 109
106 $ hg clone https://bitbucket.org/bgneal/enigma 110 $ hg clone https://bitbucket.org/bgneal/enigma
107 111
108 Once you have obtained a copy of the source somehow, to install:: 112 If you did not use pip, you can install with this command::
109 113
110 $ python setup.py install 114 $ python setup.py install
111 115
112 116
113 Documentation 117 Documentation
155 Machine is on YouTube: `Nadia Baker & Enigma demo`_. 159 Machine is on YouTube: `Nadia Baker & Enigma demo`_.
156 160
157 161
158 .. _Enigma machines: http://en.wikipedia.org/wiki/Enigma_machine 162 .. _Enigma machines: http://en.wikipedia.org/wiki/Enigma_machine
159 .. _Python: http://www.python.org 163 .. _Python: http://www.python.org
160 .. _Python Package Index: http://pypi.python.org/pypi 164 .. _Python Package Index: http://pypi.python.org/pypi/py-enigma/
165 .. _pip: http://pip.openplans.org/
161 .. _Py-Enigma Bitbucket page: https://bitbucket.org/bgneal/enigma 166 .. _Py-Enigma Bitbucket page: https://bitbucket.org/bgneal/enigma
162 .. _Mercurial: http://mercurial.selenic.com/ 167 .. _Mercurial: http://mercurial.selenic.com/
163 .. _Sphinx: http://sphinx.pocoo.org/ 168 .. _Sphinx: http://sphinx.pocoo.org/
164 .. _issue tracker: https://bitbucket.org/bgneal/enigma/issues 169 .. _issue tracker: https://bitbucket.org/bgneal/enigma/issues
165 .. _Cipher Machines and Cryptology website: http://users.telenet.be/d.rijmenants/index.htm 170 .. _Cipher Machines and Cryptology website: http://users.telenet.be/d.rijmenants/index.htm