Development

Please make sure to check your system meets the following requirements

• J2SE for your operating system is installed
• The system variable %JAVA_HOME% (or $JAVA_HOME on Unix) is defined and points to the installation directory of the J2SE
• CVS is installed (this is the basic tool for accessing the sourcecode repository)
• SSH is installed (used for encryption of data when accessing Sourceforge)

To build GenJ on your machine follow these steps:

 $ cd **genj-source-directory**
 $ cvs -d:pserver:genj.cvs.sourceforge.net:/cvsroot/genj co -P dev/app
 $ cd dev/app
 $ ./build clean
 $ ./build run

If you would like to contribute to the development process please register an account with Sourceforge and say hello in the forum to get access-rights to cvs.

Checking out the sources will roughly look like this (adopt accordingly for platform other than windows):

 $ cd **local-genj-work-directory**
 $ set cvs_rsh=ssh
 $ cvs -d :ext:**sourceforge-username**@genj.cvs.sourceforge.net:/cvsroot/genj co -P dev/app 
 $ cd ./dev/app/doc
 $ vi readme1st.txt
 $ cvs ci readme1st.txt

The main part of the GenJ API (Gedcom, Reporting, IO, etc.) is available as GenJ API Javadoc. Be sure to consult the documentation for CVS and feel free to ask questions through the Forum.

Please follow these guidelines while working with cvs:

• use 'cvs checkout', 'cvs checkin', 'cvs update' as desired
• don't use 'cvs admin', 'cvs add', 'cvs remove' as it is difficult to cleanup the repository if something goes wrong here
• provide comments when checking in
• use an editor that leaves files alone aside from your explicit changes and that can handle UTF-8 if necessary
• behave well and have fun :)

TBD

TBD