Getting Started with J-Bird using CVS

    If you want to download the source code of J-Bird using CVS
    and compile it yourself, you have more to do than if you
    install a compiled version. It's assumed that you are
    competent working with both CVS and Java.  If you know
    little about either CVS or Java, this method is not for you.
    There is an alternative method for downloading and compiling
    the source code without having to install CVS.  It's described
    as "the easy way" at http://j-bird.sourceforge.net/hacking.html#cvs.

    CVS is a tool that is native to Unix. It is available
    under Microsoft Windows through the Cygwin tools
    (http://www.cygwin.com/).  I've not actually used Cygwin
    since 1998 and have not attempted to use it with J-Bird.
    Hence, you are on your own.  However, if you successfully
    work with J-Bird in a Cygwin environment, please pass on
    tips or instructions for the benefit of others. 

Prerequisites

To compile and test J-Bird you need to install a few things.

      - A Java development environment for your platform that
	supports at least the Java 1.2 specification. New
	environments are generally better than old environments.

  	Place the binary directory of the Java environment
	on your path.

      - Install CVS on your machine.

      -	Install Apache jakarta-ant (http://jakarta.apache.org/ant/index.html) 
	including the optional classes.  The version of ant must be 1.4 or 
	greater.  Put the ant executable on your path, and put its jar file
	on your classpath.

Obtaining J-Bird using CVS

      - Decide where you want to install the source directory
	and make that directory your current directory.  For
	example, if you want J-Bird to be in ~/usr/src/jbird,
	cd ~/usr/src.

      - Enter the following 2 commands, and when prompted for
	a password, simply press return.

	cvs -d:pserver:anonymous@j-bird.cvs.sourceforge.net:/cvsroot/j-bird login
	cvs -d:pserver:anonymous@j-bird.cvs.sourceforge.net:/cvsroot/j-bird co jbird

	See also http://sourceforge.net/cvs/?group_id=19835

Compiling

	ant allclasses

	or on Mac OS X

	ant allclasses-mac

Building a master species list

	Before using J-Bird you must build a master list of species.
	Presently, there are two options: 1) read in a copy of
	Sibley & Monroe's list of World birds that is curated by
	Rolf A. de By or 2) read in the AOU Checklist of North
	American birds.  Planned for the future are the
	possibilities of reading in a master bird list from
	any database table for which you have an appropriate
	JDBC driver as well as reading from a delimited text
	file.

	To use Sibley and Monroe's list, you need to download
	two text files from Rolf A. de By's web site and place
	them in the directory into which the downloads subdirectory
	of your jbird direcotry (e.g., ~/usr/src/jbird/downloads).
	The files are families.prt and smlist.  You can obtain 
	them from http://www.itc.nl/~deby/SM/sm.html. Note that 
	you should read through Rolf de By's text and be willing 
	to accept his terms of use before downloading the files.  

        To use the AOU Checklist of North American Birds,
	you need to download it from 
	http://www.aou.org/aou/birdlist.html.
	You want the "DBF version". Rename the file to
	birdlist.DBF if you plan to use Zhao Yonghong's dbf 
	driver to read it. Place the file birdlist.DBF into the 
	downloads subdirectory of your jbird directory (e.g.,
	~/usr/src/jbird/downloads).

	Once things are in place run:

		ant run-builder

	or on Mac OS X

		ant run-builder-mac

Running J-Bird

	ant run-jbird

	or on Mac OS X

	ant run-jbird-mac