Changeset 224 for trunk

Timestamp:

06/30/07 12:08:51 (5 years ago)

Author:

marc

Message:

Major fixes to documentation

Location:

trunk

Files:

• DOCUMENTATION (modified) (1 diff)
• HACKING (modified) (4 diffs)
• README (modified) (7 diffs)
• README.Debian (modified) (1 diff)
• README.Windows (modified) (1 diff)

trunk/DOCUMENTATION

@@ -1 @@
-See Section 5 of the README ("DOCUMENTATION") for documentation information.
+See Section 4 of the README ("DOCUMENTATION") for documentation information.
+
 See HACKING file if you intend to change Itaka's source code.

trunk/HACKING

@@ -1 @@
-NOTE: This guide is a rough reference, and will always mostly be incomplete.
+NOTE: This guide is a rough reference, please take the time to read the code
+line by line, as it is not that long.
 
 Abstract:
@@ -7 +8 @@
     of the other to a certain extent. First there is the core loader
     'itaka.py', which in turn loads the Console and Configuration handlers
-    ('console.py' and 'configuration.py'). The configuration is read and
+    ('console.py' and 'config.py'). The configuration is read and
     loaded, and the passed to the  new instance of our Console handler. 
     
@@ -41 +42 @@
 
 
-Technichal standards:
+Technical standards:
     * Inter-class communication: it is done by passing instances of one class
       to the child object that needs it. For example, the 
@@ -66 +67 @@
     Itaka is fully documented with Epydoc.
 
-    You can ownload epydoc from http://epydoc.sourceforge.net/
+    You can download epydoc from http://epydoc.sourceforge.net/
 
     You can generate documentation using epydoc.
 
-    mkdir doc
-    epydoc --html -o doc -n Itaka -u "http://itaka.jardinpresente.com.ar" *.py
+        mkdir doc
+        epydoc --html -o doc -n Itaka -u "http://itaka.jardinpresente.com.ar" *.py
 

trunk/README

@@ -1 @@
-Itaka
+Itaka: Screenshooting de Mercado.
 Version 1.0
 
@@ -6 +6 @@
 CONTENTS:
 ---------
-1. ABOUT ITAKA
-2. REQUIRED LIBRARIES
-3. INSTALLATION
-4. DEBIAN PACKAGE
-5. DOCUMENTATION
-6. HACKING
-7. RELEASE NOTES
-8. PROGRAM CREDITS
+1. REQUIRED LIBRARIES
+2. INSTALLATION
+3. DEBIAN PACKAGE
+4. DOCUMENTATION
+5. HACKING
+6. RELEASE NOTES
+7. PROGRAM CREDITS
 
-1. ABOUT ITAKA:
-
-Itaka is an on-demand screen capture server for Windows, Mac Os X and Linux. It is developed in Python, PyGTK and the Twisted Framework. It prominently features a polished easy to use interface, with a robust backend server.
-
-2. REQUIRED LIBRARIES:
+1. REQUIRED LIBRARIES:
 
 Itaka requires the following programs/libraries.
@@ -25 +20 @@
 - Python 2.3 or higher
 - PyGTK 2.10.0 or higher
+- GTK 2.10 or higher
 - Twisted 2.2.0 or higher
 
-- GTK 2.10 or higher
-
-3. INSTALLATION:
+2. INSTALLATION:
 
 Itaka needs to be installed as the root user.
@@ -43 +37 @@
 To uninstall, once again as root type 'make uninstall'
 
-4. DEBIAN PACKAGE:
+3. DEBIAN PACKAGE:
 
 To create the Debian package simply do:
@@ -50 +44 @@
     debuild
 
-5. DOCUMENTATION:
+4. DOCUMENTATION:
 
 Itaka uses Epytext Markup Language to comment its code. 
 
-You can ownload epydoc from http://epydoc.sourceforge.net/
+You can download epydoc from http://epydoc.sourceforge.net/
 
 You can generate documentation using epydoc.
 
-mkdir doc
-epydoc --html -o doc -n Itaka -u "http://itaka.jardinpresente.com.ar" *.py
+    mkdir doc
+    epydoc --html -o doc -n Itaka -u "http://itaka.jardinpresente.com.ar" *.py
 
-6. HACKING
+5. HACKING
 
-If you intend to change Itaka source coude, please read the HACKING file.
+If you intend to change Itaka source code, please read the HACKING file.
 
-Any questions should be emailed to me directly.
+6. RELEASE NOTES:
 
-7. RELEASE NOTES:
-
-This is the second release of Itaka. 
-
-See ChangeLog for more detailed information.
+See the ChangeLog for more detailed information.
 
 Donations for this software would be greatly appreciated. This software is 
@@ -81 +71 @@
 Please visit http://itaka.jardinpresente.com.ar to donate.
 
-This program was developed under Ubuntu GNU/Linux and is released under the GPL license.
+This program was developed under Ubuntu GNU/Linux and is released under the GNU/GPL license.
 
-See COPYING file for further license information
+See COPYING file for further license information.
 
-8. PROGRAM CREDITS:
+7. PROGRAM CREDITS:
 
 Special thanks to James Henstridge for the excellent Python-GTK bindings and 
@@ -95 +85 @@
 Thanks to Nahuel M. for his continuing support and inspiration.
 
-Itaka's icon is based upon the work of the Tango Project and is follows their licensing.
+Itaka's icon is based upon the work of the Tango Project and follows their licensing.
 
-This README file and the Makefile are based on the works of the BloGTK project (http://blogtk.sourceforge.net)
+This README file and the Makefiles are based on the works of the BloGTK project (http://blogtk.sourceforge.net)
 
 Thanks to all Itaka users for bug reports, feature requests, and their support 

trunk/README.Debian

@@ -1 @@
-See Section 4 of the README ("DEBIAN PACKAGE") for building instructions.
+See Section 3 of the README ("DEBIAN PACKAGE") for building instructions.
 
 Binaries for Debian/Ubuntu are already provided officially upstream. 

trunk/README.Windows

@@ -2 +2 @@
 Twisted (http://tmrc.mit.edu/mirror/twisted/Twisted/2.5/Twisted_NoDocs-2.5.0.win32-py2.5.exe).
 
-You can also install all the components manually from their respective sites listed in the Requirements section.
+You can also install all the components manually from their respective sites.