~ubuntu-branches/ubuntu/quantal/hawtjni/quantal

« back to all changes in this revision

Viewing changes to webgen/src/building.page

  • Committer: Bazaar Package Importer
  • Author(s): Miguel Landaeta
  • Date: 2010-08-05 19:40:25 UTC
  • Revision ID: james.westby@ubuntu.com-20100805194025-3004hn889accwu2i
Tags: upstream-1.0~+git0c502e20c4
ImportĀ upstreamĀ versionĀ 1.0~+git0c502e20c4

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
---
 
2
title: Building
 
3
--- name:overview
 
4
 
 
5
# How to Build {project_name:}
 
6
The way most developers get started contributing to a project.
 
7
 
 
8
--- name:content 
 
9
 
 
10
## Building 
 
11
 
 
12
{project_name:} uses [Maven](http://maven.apache.org/) as its build tool. If you don't fancy using Maven you can use your IDE directly or [Download](download.html) a distribution or JAR.
 
13
 
 
14
Alternatively you can try using [sbt](sbt.html) which is particularly good for rapid edit-compile-test cycles
 
15
 
 
16
### Prequisites
 
17
 
 
18
*Required:*
 
19
* Download and [install Maven](http://maven.apache.org/download.html)
 
20
* Get the latest [Source](source.html)
 
21
* Java 1.5
 
22
 
 
23
### Maven options
 
24
 
 
25
To build {project_name:} maven has to be configured to use more memory
 
26
 
 
27
    set MAVEN_OPTS=-Xmx512m -XX:MaxPermSize=128m
 
28
 
 
29
### A normal build
 
30
 
 
31
    mvn install
 
32
 
 
33
### Doing a Quick Build
 
34
 
 
35
The following avoids running all the unit test cases, we just skip the test running phase and not the building part
 
36
 
 
37
    mvn -Dtest=false clean install
 
38
 
 
39
### Using an IDE
 
40
 
 
41
If you prefer to use an IDE then you can auto-generate the IDE's project files using maven plugins. e.g.
 
42
 
 
43
    mvn eclipse:eclipse
 
44
  
 
45
or
 
46
 
 
47
    mvn idea:idea
 
48
 
 
49
### Importing into Eclipse
 
50
 
 
51
If you have not already done so, you will need to make Eclipse aware of the Maven repository so that it can build everything. In the preferences, go to `Java -> Build Path -> Classpath` and define a new Classpath Variable named `M2_REPO` that points to your local Maven repository. i.e. `~/.m2/repository` on Unix and `c:\Documents and Settings\$username\.m2\repository` on Windows).
 
52
 
 
53
You can also get Maven to do this for you:
 
54
 
 
55
    mvn eclipse:add-maven-repo -Declipse.workspace=/path/to/the/workspace/ 
 
56
 
 
57
 
 
58
### See Also
 
59
 
 
60
* [Source](source.html)
 
61
* [Maven Reports](maven.html)