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

SourceForge Headquarters 1320 Columbia Street Suite 310 San Diego, CA 92101 +1 (858) 422-6466

Revision: 39
          http://svn.sourceforge.net/cherbot/?rev=39&view=rev
Author:   christianhujer
Date:     2006-10-30 01:03:48 -0800 (Mon, 30 Oct 2006)

Log Message:
-----------
Added typical project documentation files.

Added Paths:
-----------
    trunk/CREDITS
    trunk/FAQ
    trunk/INSTALL
    trunk/LICENSE
    trunk/NEWS
    trunk/README

Removed Paths:
-------------
    trunk/README.txt

Added: trunk/CREDITS
===================================================================

--- trunk/CREDITS	                        (rev 0)
+++ trunk/CREDITS	2006-10-30 09:03:48 UTC (rev 39)
@@ -0,0 +1,9 @@
+The following people have contributed directly to CherBot:
+
+* Christian Hujer <ch...@ri...>
+    Inventor, creator, maintainer
+
+
+CherBot wouldn't exist without the following projects:
+
+* Daimonin, an MMORPG, that has inspired Cher to create CherBot.


Property changes on: trunk/CREDITS
___________________________________________________________________
Name: svn:mime-type
   + text/plain
Name: svn:eol-style
   + LF

Added: trunk/FAQ
===================================================================
--- trunk/FAQ	                        (rev 0)
+++ trunk/FAQ	2006-10-30 09:03:48 UTC (rev 39)
@@ -0,0 +1,4 @@
+FAQ
+---
+
+No faq yet.


Property changes on: trunk/FAQ
___________________________________________________________________
Name: svn:mime-type
   + text/plain
Name: svn:eol-style
   + LF

Added: trunk/INSTALL
===================================================================
--- trunk/INSTALL	                        (rev 0)
+++ trunk/INSTALL	2006-10-30 09:03:48 UTC (rev 39)
@@ -0,0 +1,14 @@
+BUILDING / INSTALLING CHERBOT
+-----------------------------
+
+
+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 run CherBot, run the .jar file that was created as a result of the build
+process.  Run: java -jar CherBot.jar


Property changes on: trunk/INSTALL
___________________________________________________________________
Name: svn:mime-type
   + text/plain
Name: svn:eol-style
   + LF

Added: trunk/LICENSE
===================================================================
--- trunk/LICENSE	                        (rev 0)
+++ trunk/LICENSE	2006-10-30 09:03:48 UTC (rev 39)
@@ -0,0 +1,9 @@
+CHERBOT LICENSE INFORMATION
+---------------------------
+
+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.


Property changes on: trunk/LICENSE
___________________________________________________________________
Name: svn:mime-type
   + text/plain
Name: svn:eol-style
   + LF

Added: trunk/NEWS
===================================================================
--- trunk/NEWS	                        (rev 0)
+++ trunk/NEWS	2006-10-30 09:03:48 UTC (rev 39)
@@ -0,0 +1,5 @@
+NEWS
+----
+
+2006-10-27
+    CherBot has become a project hosted on SourceForge.


Property changes on: trunk/NEWS
___________________________________________________________________
Name: svn:mime-type
   + text/plain
Name: svn:eol-style
   + LF

Added: trunk/README
===================================================================
--- trunk/README	                        (rev 0)
+++ trunk/README	2006-10-30 09:03:48 UTC (rev 39)
@@ -0,0 +1,128 @@
+CHERBOT README
+--------------
+
+This file contains some important information about CherBot.  You should read it
+first.
+
+
+TABLE OF CONTENTS
+* project description
+* project website
+* system requirements
+* file structure
+* build / installation (see file INSTALL)
+* maintainers / credits (see file CREDITS)
+* project news (see file NEWS)
+* mailing lists
+* license information (see file LICENSE)
+
+
+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.
+
+The network code has been temporarily removed because it awaits approval of the
+daimonin server developers.
+
+
+PROJECT WEBSITE
+
+Project homepage: http://cherbot.sourceforge.net/
+Project website:  http://sourceforge.net/projects/cherbot/
+
+
+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.
+
+Ant 1.6.5
+    Previous versions of Ant might work but are not tested.
+
+
+FILE STRUCTURE
+
+build.xml
+    The build file to build the project with Ant.
+
+COPYING
+    CherBot license conditions.  Note: applies to CherBot only, not third party
+    libraries.
+
+CREDITS
+    List of project contributors.
+
+dest/
+    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.
+
+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.
+
+LICENSE
+    File with license information.
+
+project.properties
+    File with automatically changed settings for Ant.
+
+src/
+    Source files.
+
+src/net/ (net)
+    Core CherBot sources.
+
+src/doc/
+    Documentation source files (website).
+
+src/test/ (test)
+    Unit test suite for automated unit testing of CherBot.
+
+tools/
+    Small sometimes CherBot-based programs for use by CherBot developers.
+
+
+BUILD / INSTALLATION
+
+See the file INSTALL.
+
+
+MAINTAINERS / CREDITS
+
+See the file CREDITS
+
+
+PROJECT NEWS
+
+See the file NEWS
+
+
+MAILING LISTS
+
+CherBot mailing lists are the usual sourceforge hosted sourceforge project
+mailing lists.  The current mailing lists are:
+* che...@li...
+    News for CherBot users and developers (Low traffic, read only)
+* che...@li...
+    CherBot developer talk list
+* che...@li...
+    cvs commit digest list (currently unused, and probably being replaced
+    by a corresponding svn commit digest list soon)
+
+
+LICENSE INFORMATION
+
+See the file LICENSE


Property changes on: trunk/README
___________________________________________________________________
Name: svn:mime-type
   + text/plain
Name: svn:eol-style
   + LF

Deleted: trunk/README.txt
===================================================================
--- trunk/README.txt	2006-10-30 09:00:29 UTC (rev 38)
+++ trunk/README.txt	2006-10-30 09:03:48 UTC (rev 39)
@@ -1,4 +0,0 @@
-CherBot currently is not compilable.
-We're working on this problem.
-The source code currently reflects CherBot V1.
-The network code has been temporarily removed because it awaits approval of the daimonin server developers.


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


