Mercurial > public > enigma

comparison README.txt @ 45:19d33ff901af

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add more read the docs links in README. Adjust MANIFEST.in for docs.
author Brian Neal <bgneal@gmail.com>
date Tue, 05 Jun 2012 18:18:28 -0500
parents f2399d731ee1
children ad9d606ef5fa
comparison
equal deleted inserted replaced
44:f2399d731ee1 45:19d33ff901af
92 92
93 Py-Enigma is written in Python_, specifically Python 3.2. It has no other 93 Py-Enigma is written in Python_, specifically Python 3.2. It has no other
94 requirements or dependencies. 94 requirements or dependencies.
95 95
96 96
97 Project Status
98 --------------
99
100 This project is very new and is considered alpha software. However at even this
101 stage it is possible to encrypt and decrypt authentic Enigma messages.
102
103
104 Installation 97 Installation
105 ------------ 98 ------------
106 99
107 After the project gets a bit more mature I will add Py-Enigma to the `Python 100 After the project gets a bit more mature I will add Py-Enigma to the `Python
108 Package Index`_ (PyPI). In the meantime, you may download a tarball or .zip file 101 Package Index`_ (PyPI). In the meantime, you may download a tarball or .zip file
118 111
119 112
120 Documentation 113 Documentation
121 ------------- 114 -------------
122 115
123 The latest documentation is available at 116 The latest documentation is available at `Read the Docs
124 `Read the Docs <http://readthedocs.org/docs/py-enigma/en/latest/>`_. 117 <http://readthedocs.org/projects/py-enigma/>`_. There you can `browse the
118 documentation online <http://readthedocs.org/docs/py-enigma/en/latest/>`_, or
119 `download it in a variety of formats
120 <http://readthedocs.org/projects/py-enigma/downloads/>`_.
125 121
126 Sources for the documentation are also included in Sphinx_ format. If you 122 Sources for the documentation are also included in Sphinx_ format. If you
127 install Sphinx you can generate the documentation in several output formats. 123 install Sphinx you can generate the documentation in several output formats.
128 124
129 125