[Cherbot-commit] SF.net SVN: cherbot:[129] trunk

[<chr...@us...>]

Revision: 129
          http://cherbot.svn.sourceforge.net/cherbot/?rev=129&view=rev
Author:   christianhujer
Date:     2008-11-30 22:43:26 +0000 (Sun, 30 Nov 2008)

Log Message:
-----------
Improved documentation: shorter sentences, easier to read and understand.

Modified Paths:
--------------
    trunk/CREDITS
    trunk/FAQ
    trunk/INSTALL
    trunk/LICENSE
    trunk/README

Modified: trunk/CREDITS
===================================================================
--- trunk/CREDITS	2008-11-30 22:28:50 UTC (rev 128)
+++ trunk/CREDITS	2008-11-30 22:43:26 UTC (rev 129)
@@ -7,3 +7,4 @@
 CherBot wouldn't exist without the following projects:
 
 * Daimonin, an MMORPG, that has inspired Cher to create CherBot.
+* Ragnor, who's always been an excellent partner in online discussions.

Modified: trunk/FAQ
===================================================================
--- trunk/FAQ	2008-11-30 22:28:50 UTC (rev 128)
+++ trunk/FAQ	2008-11-30 22:43:26 UTC (rev 129)
@@ -2,12 +2,19 @@
 ---
 
 Q: How do I run CherBot?
-A: Currently CherBot cannot be really run yet. There are only three test modules that you can run:
-* net.sf.cherbot.CherBot
-* net.sf.cherbot.metaserver.MetaServerInfo
-* net.sf.cherbot.IRCConnection
+A: Currently CherBot cannot be really run yet.
+   There are only three test modules that you can run:
+   * net.sf.cherbot.CherBot
+   * net.sf.cherbot.metaserver.MetaServerInfo
+   * net.sf.cherbot.IRCConnection
 
-Q: When I try to run CherBot I get java.sql.SQLException: No suitable driver found for jdbc:derby:cherbotdb;create=true
-A: You need to have derby.jar on your class path. Try this:
-java -cp CherBot.jar:$JAVA_HOME/db/lib/derby.jar net.sf.cherbot.CherBot
-You may have to replace the path to derby.jar to something else on your system if Derby has been installed outside of JAVA_HOME.
+Q: When I try to run CherBot I get java.sql.SQLException:
+   No suitable driver found for jdbc:derby:cherbotdb;create=true
+A: You need to have derby.jar on your class path.
+   derby.jar is a database system that's used by CherBot.
+   Try this:
+   java -cp CherBot.jar:$JAVA_HOME/db/lib/derby.jar net.sf.cherbot.CherBot
+   On some systems, derby is not available per default.
+   If that is the case, download and install derby.
+   On some systems, derby is somewhere else.
+   If that is the case, modify the path to point to your derby.

Modified: trunk/INSTALL
===================================================================
--- trunk/INSTALL	2008-11-30 22:28:50 UTC (rev 128)
+++ trunk/INSTALL	2008-11-30 22:43:26 UTC (rev 129)
@@ -5,10 +5,10 @@
 To build CherBot, you need Java 5.0 and Ant 1.6.5.
 
 
-To build CherBot, just run ant in the project's root directory or specifying the
-build.xml in the project's root directory.  To find out, what other options
-you have for building CherBot, try "ant -projecthelp".
+To build CherBot, just run ant in the project's root directory.
+Or specifying the build.xml in the project's root directory.
+The build.xml is documented.
+Try "ant -projecthelp" to get the documentation.
 
-
-To run CherBot, run the .jar file that was created as a result of the build
-process.  Run: java -jar CherBot.jar
+To run CherBot, run the .jar file that's been built.
+java -jar CherBot.jar

Modified: trunk/LICENSE
===================================================================
--- trunk/LICENSE	2008-11-30 22:28:50 UTC (rev 128)
+++ trunk/LICENSE	2008-11-30 22:43:26 UTC (rev 129)
@@ -3,7 +3,6 @@
 
 CherBot is licensed under GPL.  See file COPYING.
 
-CherBot uses some third part libraries, especially for building.  These
-libraries are contained in the lib/ directory and have their own licenses.  See
-the corresponding LICENSE-*-files in the lib/ directory for the licenses of
-third party libraries.
+CherBot uses some third part libraries, especially for building.
+These libraries are contained in the lib/ directory and have their own licenses.
+See the LICENSE-*-files in the lib/ directory for that.

Modified: trunk/README
===================================================================
--- trunk/README	2008-11-30 22:28:50 UTC (rev 128)
+++ trunk/README	2008-11-30 22:43:26 UTC (rev 129)
@@ -1,8 +1,8 @@
 CHERBOT README
 --------------
 
-This file contains some important information about CherBot.  You should read it
-first.
+This file contains some important information about CherBot.
+You should read it first.
 
 
 TABLE OF CONTENTS
@@ -19,14 +19,18 @@
 
 PROJECT DESCRIPTION
 
-CherBot is an information bot for Daimonin which probably would also work pretty
-well with Angelion and to less extent with Crossfire.  CherBot keeps track of
-which players collect which items, who's been online, determines a level
-ranking, provides a mail system for mailing offline players, manages clans and
-more.
+CherBot is an information bot for Daimonin.
+It probably would also work pretty well with Angelion and Crossfire.
+CherBot keeps track of some interesting in-game features:
+- information which players collect which items
+- information who's been online
+- player level ranking
+- a mail system for mailing offline players
+- manages clans
+- and more.
 
-The network code has been temporarily removed because it awaits approval of the
-daimonin server developers.
+The network code has been temporarily removed.
+It will be re-added if it has been approved by the daimonin server developers.
 
 
 PROJECT WEBSITE
@@ -38,8 +42,8 @@
 SYSTEM REQUIREMENTS
 
 Java 5.0
-    Previous versions of Java will not work.  CherBot uses Generics, autoboxing,
-    static imports, foreach loops, assertions and varargs quite a lot.
+    Previous versions of Java will not work.
+    Java 1.6 is recommended.
 
 Ant 1.6.5
     Previous versions of Ant might work but are not tested.
@@ -51,8 +55,8 @@
     The build file to build the project with Ant.
 
 COPYING
-    CherBot license conditions.  Note: applies to CherBot only, not third party
-    libraries.
+    CherBot license conditions.
+    Note: applies to CherBot only, not third party libraries.
 
 CREDITS
     List of project contributors.
@@ -61,17 +65,17 @@
     The directory containing generated files.
 
 developer.proprties
-    Optional file for changing default settings of the Ant build.  You won't
-    need to tweak this file for normal building.  But if you want to set or
-    override properties for build.xml, this is the place to put them.
+    Optional file for changing default settings of the Ant build.
+    You won't need to tweak this file for normal building.
+    But it allows that you set or override properties.
 
 dist/
     Generated directory containing distribution archives.
 
 lib/
-    Directory containing third part libraries used to build CherBot.  Please note
-    that these third party libraries have their own license conditions.  The
-    licenses of the third party libraries are included in the lib/ directory.
+    Directory containing third part libraries used to build CherBot.
+    Note: that these third party libraries have their own license conditions.
+    The licenses of the third party libraries are found in the lib/ directory.
 
 LICENSE
     File with license information.


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.