source: trunk/Building_RomRaider.txt @ 79

Revision 79, 3.7 KB checked in by lizzardo, 5 years ago (diff)

Minor updates to building instructions, set repository location to use https

RevLine 
[43]1Steve Wadsworth (lizzardo on RomRaider forum)
2
3This file is an attempt to consolidate available information on setting up, building,
[66]4and packaging RomRaider.  All instructions assume a Windows environment and the use
5of Eclipse for development.  Apologies for the Windows-centricity, but some of the
6tools inherited from the RomRaider project are Windows-based.
[43]7
8----------------------------------------------
9Setting up the project (from romraider.com)
10
[66]11As an open source project, RomRaider depends on Java developers like you for
12enhancements, bug fixes and general maintenance. This page is meant to be a
13guide to setting up a development environment from scratch. The guide was
[43]14originally written by Tgui in this thread and has been adapted and revised.
15
[66]16RomRaider’s official IDE is Eclipse. You are free to use any Java IDE you
17choose, but due to the extremely simple process of setting up the environment
[43]18and the power of Eclipse, it’s probably your best choice.
19
20    * Installing Eclipse and Subclipse
21          o Install the latest version of the Java Development Kit
22          o Get and Install Eclipse for your platform
[66]23          o Install Subclipse for Subversion (SVN) integration, following the
24              steps outlined here.
[43]25    * Setting up the RomRaider project
[66]26          o Open the Java perspective in Eclipse by clicking
[43]27              Window > Open Perspective > Java
28          o Right click in the package explorer and select “Import…”
29          o Select “Checkout Projects from SVN” and click “Next”
30          o Select “Use a new repository location:” and click “Next”
[66]31          o Enter “https://svn2.assembla.com/svn/romraider” and click “Next”
[43]32          o Highlight “trunk” in the folder tree and click “Next”
[66]33          o Name the project “romraider” and click “Finish”
[43]34
[66]35Now all you have to do is add the Jars within your libs dir to the project
[43]36java build path. You should read this.
37
38http://www.eclipse.org/documentation/main.html
39
40----------------------------------------------
41
[66]42Notes on the above:
[43]43
441)  Make sure the build path for the Java builder is set correctly.  On the top menu:
45
46        Project -> Properties -> Java Build Path
47
48    On the Source tab, the default output folder should be set to
49
[66]50        romraider/build/classes
[43]51
522)  The jars in the java build path mentioned above should be correct in the SVN
[66]53    repository.
54
553)  A command line Subversion client needs to be installed and available in the default
[79]56    path.  To verify this, open a command prompt and run
57   
58        svn info https://svn2.assembla.com/svn/romraider
59       
60    You should get a response of the form
61   
62        Path: romraider
63        URL: https://svn2.assembla.com/svn/romraider
64        Repository Root: https://svn2.assembla.com/svn/romraider
65        Repository UUID: 38686702-15cf-42e4-a595-3071df8bf5ea
66        Revision: 78
67        Node Kind: directory
68        Last Changed Author: kascade
69        Last Changed Rev: 78
70        Last Changed Date: 2008-05-02 15:50:23 -0700 (Fri, 02 May 2008)
[43]71
[79]72    If this does not work correctly, the ant build will fail.
73
[43]74The ant build file is in the main directory and uses the default name of "build.xml".
75
76The Java builder is set as the default.  During development it's convenient to have
77the "Problems" pane show warning and errors.  The ant build does not send warnings
[66]78or errors there.  The ant build is primarily for automation of the complete build
79process for packaging.
[43]80
81To build using ant, right-click on the build
[66]82file in the Package Explorer (Java perspective) and select
[43]83
84Run As -> Ant Build
85
86The "help" target lists available targets with a brief description of each.
87
[79]88The "all" target does just that.  It rebuilds everything, finishing with the installers.
[50]89
90
[79]91
Note: See TracBrowser for help on using the repository browser.