Table of Contents
Muse API is current developed under Sun JDK 1.4.2_06. All releases before 0.5b1 are compatible with JDK 1.2+. All releases after 0.5b1 are now designated JDK 1.4+ only. Please note that I haven't tested the compiles under other JDKs. If you run into problems, report them to me so I can correct them. If you successfully run and compile the software under different latforms, let me know:
Muse API also uses third-party libraries. The required libraries are already distributed as part of the package, so no extra downloads are currently necessary.
JSSE is now required for compile as of 0.8a2 and above. If SSL is not used, it may not be necessary to include it in your classpath during runtime. If you are running under JDK 1.4+, then you don't need to include it as JSSE is part of the runtime environment already.
The list of changes are packaged within the distribution. A shortened online version of the changelog is also available.
The Muse API does not come separately for each individual module. It is a complete API and will be packaged as thus. However, each individual module can be used separately from other modules. As each module gets implemented and released, it will be incorporated into the API.
Current versions and releases
Due to the migration from Sourceforge to Berlios for project hosting, all versions on and after 0.8a5 will be hosted at Berlios. Versions 0.8a5 and earlier are still hosted at Sourcefoge. You don't have to worry about this because all the download links listed below already point to the proper places.
As you can tell, Muse release timeframe is not consistent. There may be massive number of fixed and additions to the current code, but is not yet released out as a distribution. In order to satisfy those developers who do not mind working with bleeding edge codes and want the new features and fixes, Muse's main code base is now hosted at Berlios using Subversion as the version control mechanism.
Subversion provides many advantages over CVS. You can read more about it at http://subversion.tigris.org/. You can now access the latest code development at Berlios. The steps to download the latest source code is outlined below:
# To download the latest HEAD branch code
svn checkout svn://svn.berlios.de/muse/muse/trunk
# To download the specific version releases
svn checkout svn://svn.berlios.de/muse/muse/tag/<version number, ie 0.8a5>
NOTE: Do not follow the instructions indicated on Berlios. They tell you to do the following:
# DO NOT FOLLOW THIS
svn checkout svn://svn.berlios.de/muse
The above command will download the entire repository to your hard drive. This repository will include all HEAD trunk codes, branch codes, and release codes for all versions. You're gonna be waiting for a long time just to donwload files that you do not need.
After you download the code, you can work with it just as you normally do with the distribution archives. You will have to compile the code manually yourself, but that's just a simple matter of typing "ant".
For Javadocs, simply run "ant javadocs" after you uncompress the zip files to obtain them. For example:
ant javadocs
Alternatively, there is an Online Javadocs for the newest release hosted here for convenience.