Jupiter ReadMe

Hongbing Kou
Collaborative Software Development Laboratory
University of Hawaii

$Id$


This file introduces you to the major components of the Jupiter (code review plug-in for Eclipse) software system. It includes information on the contents of the package you have downloaded, instructions on how to install the system, basic invocation and usage, user documentation, developer documentation, and contact coordinates for further information. Please see the following table for links to the different sections of this README file.

Section What this Section Provides
Contents of this package Provides the contents of the Jupiter plug-in for Eclipse.
Installation Provides a detailed description of how to build the Jupiter plug-in.
User Documentation Provides a detail description of what a user may do in the Jupiter plug-in (not completed at this time).
Developer Documentation Provides a detail description of the development rules, processes, design, and build system.
Contact Information Provides the contain information for those who wish to comment about the Jupiter plug-in.


A. Contents of this package

Directory/File Contents
. Top-level directory files include:
./feature Contains files to build an Eclipse feature for Jupiter.   
  • feature.xml A feature configuration file for Jupiter. 
./plugin Contains files to build Jupiter Eclipse plugin.  
  • plugin.xml A plugin configuration file for Jupiter.
  • plugin.properties A resource file for plugin.xml
  • build.properties A build configuration file Jupiter Eclipse plugin.  
  • .project An eclipse project definition file for Jupiter. 
  • src/ Sources of Jupiter
 

./site

Contain update site definition for Jupiter.
  • site.xml The configuration file of Jupiter's update site.
  • index.html An introduction to the update site.
  • features/ Archive file of Jupiter's feature.
  • plugin/ Archive file of Jupiter's plugin. 

B. Installation

These instructions assume that you have checked out Jupiter from the SVN repository at:

# Project members authenticate over HTTPS to allow committing changes.
svn checkout https://hackystat-sensor-eclipse.googlecode.com/svn/trunk/ hackystat-sensor-eclipse --username <your account>

# Non-members may check out a read-only working copy anonymously over HTTP.
svn checkout http://hackystat-sensor-eclipse.googlecode.com/svn/trunk/ hackystat-sensor-eclipse

  1. Download and install the Java SDK version 1.5 or above.  
  2. Download and install Eclipse 3.2. 
  3. Download and install Ant 1.5.4 or above.
  4.  Open projects of Jupiter

     

  5. Build Jupiter 

    The Eclipse PDE will generate features and plugin in the jupiter-eclipse-site project. You can commit the newly generated archive files to SVN repository to make a new release of Jupiter.  

D. User documentation

See the User's Guide at http://code.google.com/p/jupiter-eclipse-plugin/wiki/UserGuide

E. Developer documentation

See developer guide at http://code.google.com/p/jupiter-eclipse-plugin/wiki/DeveloperGuide

F. Contact information

If you would like to know more about this software, or would like to be informed of future releases: