Installation Guide

Neptune is a build tool that features easy cross-project dependency management and flexible code reuse.

Since the real work is done by Ant, the ant dependency jar files are included in this release.

This version is tested with ant 1.6.3.

Steps to set up:

1. unzip the neptune.zip file, which contains:
   • README.txt ---- the readme file. Contains this installation guide.
   • LICENSE.txt ---- the license file.
   • neptune ---- the neptune files.
     • build.np ---- the build file used to build the Neptune project.
     • lib ---- the folder with neptune.jar, neptune_launch.jar and all ant jar files.
     • np.bat ---- the batch file to run neptune.
     • docs ---- the neptune documentations.
2. Install Neptune
   1. Copy the neptune folder to a folder on the local hard drive. For example, "D:\neptune".
   2. Set the NEPTUNE_HOME folder to this folder. "D:\neptune" for example.
3. Change the "path" environment variable to include the neptune folder so that the "np.bat" can be found whichever directory you are in.
4. Go to your work folder, copy the sample build.np file and make changes for your project.
5. run "np build" for executing the "build" target.
   • run "np start xyz" to execute the "start" target with "xyz" as parameter.
   • run np "start xyz, stop" to execute target "start" with parameter "xyz" and then execute target "stop".
   • run "np -i" to run neptune in interactive mode.
   • run "np -h" to get help information for the np command.

Off you fly.

To use your own Ant distribution instead:

1. Copy jfunutil.jar, jparsec.jar, jaskell.jar, neptune.jar, neptune_launch.jar into the "lib" folder under your ant home directory.
2. Copy the np.bat to the ant home directory.
3. Set the NEPTUNE_HOME to point to the ant home directory.