Commits

Anonymous committed 03005ee

Added minor changes to headlines and improved/added installation and bug report section.

Comments (0)

Files changed (1)

-TYPOTOO
-=======
+.. -*- mode: rst -*-
 
+========
+Typotoo
+========
+
+---------------------------------------------------------------
 A command-line typing tutor for accelerating typing speed.
+---------------------------------------------------------------
 
+:Author:  Dinu Gherman <gherman@darwin.in-berlin.de>
+:Homepage: http://www.dinu-gherman.net/
+:Version: Version 0.8.0
+:Date: 2007-08-12
+:Copyright: GNU Public Licence v3 (GPLv3)
 
-ABOUT
+
+About
 -----
 
 This is a simple command-line typing tutor with instant feedback for learning 
 wrong keystroke, etc...
 
 
-USING
+Using
 -----
 
 From the system command-line you use 'typotoo.py' e.g. like this::
   +:45 (93 %), -:3 (6 %) - all: 48 chars in 13.6 sec -> 212 chars/min
   
 
-FEATURES
+Features
 --------
 
 - take input text files and present them line by line on the console
 - install a Python command-line script 'typotoo.py'
 
 
-TODO
-----
+Installation
+------------
 
-- test on systems other than Mac OS X (more on Windows and Linux)
-- add logging capability
+There are multiple ways to install `typotoo`, some of which are described 
+here.
 
+1. (TODO) Using `easy_install`
+++++++++++++++++++++++++++++++++
 
-INSTALLING
-----------
+With the `easy_install` command on your system and a working internet 
+connection you can install `typotoo` with only one command in a terminal::
 
-::
+  $ easy_install typotoo
 
-  python setup.py build
-  python setup.py install
+If the `easy_install` command is not available to you and you want to
+install it before installing `typotoo`, you might want to go to the 
+`Easy Install homepage <http://peak.telecommunity.com/DevCenter/EasyInstall>`_ 
+and follow the `instructions there <http://peak.telecommunity.com/DevCenter/EasyInstall#installing-easy-install>`_.
 
-This will install a single Python script named 'typotoo.py' in your 'bin' 
+2. Manual installation
++++++++++++++++++++++++
+
+Alternatively, you can install the `typotoo` tarball after downloading 
+an archive file like ``typotoo-0.9.0.tar.gz`` and decompressing it with 
+the following command::
+
+  $ tar xfz typotoo-0.9.0.tar.gz
+
+Then change into the newly created directory ``typotoo`` and install 
+`typotoo` by running the following command::
+
+  $ python setup.py install
+
+This will install a single Python script named `typotoo.py` in your 'bin' 
 directory, usually in '/usr/local/bin'.
 
 
-TESTING
+Testing
 -------
 
 typotoo.py was mainly developped and tested on Mac OS X, but it should also
 each letter as well. It should be helpful in debugging typotoo.py on other 
 platforms like Windows.
 
-Dinu Gherman
+
+Bug reports
+-----------
+
+Please report bugs and patches to Dinu Gherman 
+<gherman@darwin.in-berlin.de>. Don't forget to include information 
+about the operating system and Python versions being used.
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.