Mercurial > public > enigma

comparison README.txt @ 42:360534b4781d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Updated README and docs with link to Read the Docs page.
author Brian Neal <bgneal@gmail.com>
date Mon, 04 Jun 2012 20:51:05 -0500
parents 560ded21dcd9
children f2399d731ee1
comparison
equal deleted inserted replaced
41:3057f16caa43 42:360534b4781d
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: Alpha 8 :Version: 0.1
9 :Date: May 30, 2012 9 :Date: June 4, 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://readthedocs.org/docs/py-enigma/en/latest/
12 :Support: https://bitbucket.org/bgneal/enigma/issues 13 :Support: https://bitbucket.org/bgneal/enigma/issues
13 14
14 15
15 Overview 16 Overview
16 -------- 17 --------
23 24
24 It is my hope that library will be useful to Enigma enthusiasts, historians, and 25 It is my hope that library will be useful to Enigma enthusiasts, historians, and
25 students interested in cryptography. 26 students interested in cryptography.
26 27
27 Py-Enigma strives to be Pythonic, easy to use, comes with unit tests, and 28 Py-Enigma strives to be Pythonic, easy to use, comes with unit tests, and
28 (coming soon) documentation. 29 documentation.
29 30
30 31
31 Scope 32 Scope
32 ----- 33 -----
33 34
117 118
118 119
119 Documentation 120 Documentation
120 ------------- 121 -------------
121 122
122 I want to use Py-Enigma as a chance to learn Sphinx_, so you can expect to see 123 The latest documentation is available at
123 some nicely formatted documentation coming soon. In the meantime, please read 124 `Read the Docs <http://readthedocs.org/docs/py-enigma/en/latest/>`_.
124 the source code. I commented it heavily so I could understand how the Enigma 125
125 machine works. 126 Sources for the documentation are also included in Sphinx_ format. If you
127 install Sphinx you can generate the documentation in several output formats.
126 128
127 129
128 Support 130 Support
129 ------- 131 -------
130 132