changeset 42:360534b4781d

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 3057f16caa43
children 378dca0509d7
files README.txt enigma/docs/source/index.rst
diffstat 2 files changed, 10 insertions(+), 7 deletions(-) [+]
line wrap: on
line diff
--- a/README.txt	Mon Jun 04 20:24:38 2012 -0500
+++ b/README.txt	Mon Jun 04 20:51:05 2012 -0500
@@ -5,10 +5,11 @@
 ------------------------------------------------------------------
 
 :Author: Brian Neal <bgneal@gmail.com>
-:Version: Alpha
-:Date: May 30, 2012
+:Version: 0.1
+:Date: June 4, 2012
 :Home Page: https://bitbucket.org/bgneal/enigma/
 :License: MIT License (see LICENSE.txt)
+:Documentation: http://readthedocs.org/docs/py-enigma/en/latest/
 :Support: https://bitbucket.org/bgneal/enigma/issues
 
 
@@ -25,7 +26,7 @@
 students interested in cryptography.
 
 Py-Enigma strives to be Pythonic, easy to use, comes with unit tests, and
-(coming soon) documentation.
+documentation.
 
 
 Scope
@@ -119,10 +120,11 @@
 Documentation
 -------------
 
-I want to use Py-Enigma as a chance to learn Sphinx_, so you can expect to see
-some nicely formatted documentation coming soon. In the meantime, please read
-the source code. I commented it heavily so I could understand how the Enigma
-machine works.
+The latest documentation is available at 
+`Read the Docs <http://readthedocs.org/docs/py-enigma/en/latest/>`_.
+
+Sources for the documentation are also included in Sphinx_ format. If you
+install Sphinx you can generate the documentation in several output formats.
 
 
 Support
--- a/enigma/docs/source/index.rst	Mon Jun 04 20:24:38 2012 -0500
+++ b/enigma/docs/source/index.rst	Mon Jun 04 20:51:05 2012 -0500
@@ -11,6 +11,7 @@
 :Date: |today|
 :Home Page: https://bitbucket.org/bgneal/enigma/
 :License: MIT License (see LICENSE.txt)
+:Documentation: http://readthedocs.org/docs/py-enigma/en/latest/
 :Support: https://bitbucket.org/bgneal/enigma/issues
 
 Py-Enigma is a historically accurate `Enigma machine