diff README.txt @ 30:62e0d0e2628b

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
line wrap: on
line diff
--- a/README.txt	Tue May 29 17:30:49 2012 -0500
+++ b/README.txt	Wed May 30 19:16:22 2012 -0500
@@ -5,8 +5,8 @@
 ------------------------------------------------------------------
 
 :Author: Brian Neal <bgneal@gmail.com>
-:Version: 0.1
-:Date: May 28, 2012
+:Version: Alpha
+:Date: May 30, 2012
 :Home Page: https://bitbucket.org/bgneal/enigma/
 :License: MIT License (see LICENSE.txt)
 :Support: https://bitbucket.org/bgneal/enigma/issues
@@ -78,9 +78,9 @@
 Assuming you have a proper key file that contains the same initial settings as
 the code above, the above example can be performed on the command-line::
 
-   $ pyenigma --key-file=keys.txt --start=WXC --text='KCH'
+   $ pyenigma.py --key-file=keys.txt --start=WXC --text='KCH'
    BLA
-   $ pyenigma --key-file=keys.txt --start=BLA --text='NIBLFMYMLLUFWCASCSSNVHAZ'
+   $ pyenigma.py --key-file=keys.txt --start=BLA --text='NIBLFMYMLLUFWCASCSSNVHAZ'
    THEXRUSSIANSXAREXCOMINGX
 
 The format of the key file can be found in the documentation.
@@ -89,7 +89,7 @@
 Requirements
 ------------
 
-Py-Enigma is written in Python_, specifically Python 3. It has no other
+Py-Enigma is written in Python_, specifically Python 3.2. It has no other
 requirements or dependencies.
 
 
@@ -111,9 +111,9 @@
 
    $ hg clone https://bitbucket.org/bgneal/enigma
 
-In the very near future I will provide a ``setup.py`` script that will allow you
-to install Py-Enigma. For the time being, just place the ``enigma`` directory on
-your ``PYTHONPATH``.
+Once you have obtained a copy of the source somehow, to install::
+
+   $ python setup.py install
 
 Documentation
 -------------