******************************************
* HOW TO set up XLogo CVS in Eclipse
*
*  Thanks to Markus Hohenwarter who has written a part of this Howto
*
*  Le Coq Loïc   http://xlogo.tuxfamily.org
******************************************

This document describes how to get active as a developer of XLogo
and set up Eclipse with Subversion (SVN).

1. Install Eclipse
2. Install "Subversive" Plugin in Eclipse
3. Get source code from XLogo SVN repository
4. Install java3D
5. Update your local source code copy
6. Commit your changes to the XLogo SVN repository


************************************************************************
* 1. Install Eclipse
************************************************************************

Eclipse is the integrated development environment (IDE) used for XLogo.
It is open source and can be downloaded from http://www.eclipse.org.

************************************************************************
* 2. Install the Eclipse plugin called "Subversive"
************************************************************************

The most friendly installation process - point Eclipse update manager to Subversive Update Site URL 
http://www.polarion.org/download/p_subversive/update-site/ and follow instructions of Installation wizard.

************************************************************************
* 3. Get source code from XLogo SVN repository
************************************************************************

Start Eclipse and do the following to get the XLogo source code:
1. Window -> Open Perspective -> Other. Select SVN Repository Exploring.

2. Right click (Apple click) on the empty SVN Repositories window.
   Context Menu -> New -> Repository Location...

3. Fill in the location information identifying the XLogo SVN repository 
   and click Finish.

	- Anonymous access:
	URL: svn://svn.tuxfamily.org/svnroot/xlogo/xlogosvn

	- Developper access
	Assuming your login is "LOGIN" and your password "PASWD"

	URL: svn+ssh://LOGIN@svn.tuxfamily.org/svnroot/xlogo/xlogosvn
	user: LOGIN: your XLogo developer account at tuxfamily.org
     	password: PASWD

4. Expand the newly-created repository location.
   Expand trunk.

5. Find the "logo" folder and right click on it.
   Context Menu -> Check Out

6. Window -> Open Perspective -> Other. Select Java (default).
   In the Java Perspective  you see the package window on the left with the 
   newly created xlogo project. Start to play with the source code!

************************************************************************
* 4. Install java3D
************************************************************************

Download java3d here: http://java.sun.com/products/java-media/3D/downloads/index.html

XLogo Main class: xlogo.Logo

************************************************************************
* 5. Update your local source code copy
************************************************************************

Whenever you start programming you will want to make sure you are working with
the latest source code from the XLogo SVN repository:
* From the Java Perspective right click (Apple click) on the "logo" project.
  Then select Team -> Update

You may also want to show the Team History and Synchronize Window:
* Window -> Show View -> Other. Select Team -> History resp. Synchronize

IMPORTANT NOTE: whenever you make any changes to existing XLogo
  code, make sure to ADD YOUR NAME and the DATE of your changes 
  in a comment at the BEGINNING AND the END of your newly created code.
  When you create a new class provide YOUR NAME and the DATE at the
  BEGINNING of the file.


************************************************************************
* 6. Commit your changes to the XLogo SVN repository
************************************************************************

If you have made changes to the XLogo source code, you will want to upload
them to the XLogo SVN repository. 

IMPORTANT NOTE: If you are not absolutely sure what you are doing during the 
following steps, then PLEASE DON'T DO IT and get into contact with Le Coq Loïc
before you proceed. Thank you!

1. Perform an UPDATE from the SVN repository:
   - In the Java Perspective right click (Apple click) on the "logo" project. 
   - Select Team -> Update

   Resolve any synchronization conflicts. You have to make sure that your local 
   version works with the latest update from the SVN repository before you 
   commit any changes.

2. COMMIT your changes to the SVN repository:
   After performing an update and resolving all synchronization issues you are
   ready to commit your changes to the SVN repository:

   - Right click (Apple click) on the "logo" project. 
   - Select Team -> Commit...
   - Enter a meaningful comment in the Commit dialog and click OK.