diff options
Diffstat (limited to 'README')
| -rw-r--r-- | README | 72 |
1 files changed, 72 insertions, 0 deletions
@@ -0,0 +1,72 @@ +ivy-java README +----------------- + +This is open source software distributed under the terms of the GNU +Lesser General Public License. See the COPYING.LIB file for details. +Some included utilities are distributed under the terms of the GNU +General Public License, a copy of which is included in the file COPYING. + +This page has been hugely inspired from the one Wes wrote for the gnu-regexp +package. As I am a newbie in package creation, I start from an existing one. + +INSTALLING + +Copy the ivy-java jar file (located in the 'lib' directory) +to your usual installation directory for Java archives. + +To use ivy-java, you will need to include it in your classpath +setting. Typically this is done by adding an entry to your CLASSPATH +variable setting with the full path to the JAR file, e.g. + csh: % setenv CLASSPATH ${CLASSPATH}:/usr/java/lib/ivy-java-1.0.5.jar + bash: % export CLASSPATH=${CLASSPATH}:/usr/java/lib/ivy-java-1.0.5.jar + DOS: > set CLASSPATH %CLASSPATH%;C:\Java\lib\ivy-java-1.0.5.jar +Various shells and operating systems may have slightly different methods. +Consult your Java virtual machine documentation for details. You may also +specify the -classpath option to the java executable, e.g. +compile: % javac -classpath /usr/java/lib/ivy-java-1.0.5.jar MyClass.java +execute: % java -classpath /usr/java/lib/ivy-java-1.0.5.jar MyClass + +DOCUMENTATION + +HTML documentation will be provided in the 'doc' directory. This is basically +a snapshot of the official ivy-java web site (see below for URL). The +documentation files are: + doc/ivy-java.1 -- man page + doc/html/api/*.html -- javadoc generated info + +UTILITIES + +ivy-java comes with a number of simple utility programs intended to test +and demonstrate its features. These are compiled into the Java archive +file. To run the TestIvySwing program, you will need the swing package if you +are running a jdk1.1 . If you want to run Probe or IvyDaemon, you will also +need gnu.getopt, which is available at +http://www.urbanophile.com/~arenn/hacking/download.html, and put those +class files in your classpath as well. + + +HACKING + +You are free to fold, spindle, mutilate and modify this library, +provided you follow the terms outlined in COPYING.LIB. The ivy-java +project team gratefully accepts any bug fixes or enhancements you may +come up with (see the TODO file if you're in need of some ideas). A +few parameters at the top of the Makefile in the 'src' directory +need to be edited to match your local system setup. + +BUG REPORTS + +Send bug reports to <jestin@cena.fr>, or join the ivy mailing list +by sending a "subscribe" message to <ivy-request@tls.cena.fr>. It helps +if you can send a code sample showing the messages you were +using and how you were using it. + +LATEST VERSION + +You can always obtain info about the latest version of ivy-java at +http://www.tls.cena.fr/~jestin/ivy-java. New versions are also announced on +the ivy mailing list (see above). + +Thanks! + +Yannick Jestin <jestin@cena.org> |