AfflictionNetworks/samskivert
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Edits and trimming.

Browse Source 
git-svn-id: https://samskivert.googlecode.com/svn/trunk@2833 6335cc39-0255-0410-8fd6-9bcaacd3b74c
This commit is contained in:
samskivert
2010-08-27 21:33:16 +00:00
parent 1e7529f069
commit c55a9c44a9
1 changed files with 28 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README
+28 -37
View File
@@ -1,38 +1,37 @@
The samskivert library The samskivert library
---------------------- ----------------------
The samskivert library (SL) aims to provide useful reusable Java routines The samskivert library (SL) aims to provide useful reusable Java routines that
that do things for which I've been unable to find useful reusable do things for which I've been unable to find useful reusable implementations on
implementations on the net. the net.
Given the emphasis on reusability, SL attempts to closely adhere to the Given the emphasis on reusability, SL attempts to closely adhere to the
following principles: following principles:
* Each individual module should depend as little as possible on other SL * Each individual module should depend as little as possible on other SL
modules. Obvious exceptions include modules that are a logical extension modules. Obvious exceptions include modules that are a logical extension of
of other modules and modules that clearly require a service that is other modules and modules that clearly require a service that is implemented
implemented by another SL module and would have to implement that by another SL module and would have to implement that service themselves in
service themselves in the absence of dependence on the other module. the absence of dependence on the other module.
* Modules should be both simple to use and as general purpose as possible. * Modules should be both simple to use and as general purpose as possible. To
To meet these two competing requirements, a balance must be struck at meet these two competing requirements, a balance must be struck at that sweet
that sweet spot where reusability is maximized. spot where reusability is maximized.
* Code included in SL will freely depend on JDK packages available in the * Code included in SL will freely depend on JDK packages available in the Java
Java 2 platform and beyond. SL is initially a repository of software 2 platform and beyond. SL is initially a repository of software useful for
useful for server-side or stand alone applications and therefore need server-side or stand alone applications and therefore need not make
not make compromises to function in the jungle of JVMs in commonly compromises to function in the jungle of JVMs in commonly available web
available web browsers. browsers.
* We are not here to reinvent the wheel, nor to provide a uniform * We are not here to reinvent the wheel, nor to provide a uniform interface to
interface to every software service under the sun. If something is every software service under the sun. If something is available in a freely
available in a freely redistributable and reusable form from someone redistributable and reusable form from someone else, it won't be found in SL.
else, it won't be found in SL. If SL depends on such software from If SL depends on such software from another source, it will provide clear
another source, it will provide clear documentation on how to get that documentation on how to get that software and make use of it within the scope
software and make use of it within the scope of SL's particular needs. of SL's particular needs. Again a balance of reusability will be struck here
Again a balance of reusability will be struck here and software that is and software that is sufficiently difficult to make usable in an arbitrary
sufficiently difficult to make usable in an arbitrary environment will environment will not be used by SL and may be "reinvented".
not be used by SL and may be "reinvented".
Building Building
-------- --------
@@ -47,6 +46,7 @@ Invoke ant with any of the following targets:
all: builds the class files and javadoc documentation all: builds the class files and javadoc documentation
compile: builds only the class files (dist/classes) compile: builds only the class files (dist/classes)
javadoc: builds only the javadoc documentation (dist/docs) javadoc: builds only the javadoc documentation (dist/docs)
tests: builds and runs the unit tests
dist: builds the distribution jar file (dist/samskivert.jar) dist: builds the distribution jar file (dist/samskivert.jar)
It is highly recommended to use the Ivy-based build file, which will It is highly recommended to use the Ivy-based build file, which will
@@ -61,21 +61,12 @@ Distribution
The samskivert library is released under the LGPL. The most recent version The samskivert library is released under the LGPL. The most recent version
of the library is available here: of the library is available here:
http://samskivert.com/code/samskivert/ http://code.google.com/p/samskivert/
Contribution Contribution
------------ ------------
Contributions to SL are welcome. Control of the CVS repository is Contributions to SL are welcome. Email mdb@samskivert.com with patches or
presently in the hands of mdb@samskivert.com, who should be emailed about suggestions.
submissions. Facilities for management of major contributions by external
parties (ie. publicly accessible CVS server) will be provided if
circumstances dictate.
Contact Information $Id$
-------------------
The person primarily responsible for SL is Michael Bayne and can be
contacted at <mdb@samskivert.com>.
$Id: README,v 1.7 2001/08/12 00:00:42 mdb Exp $