Debian Codegraph @

hawtjni-website/src/community/building.page

raw
1 ---
2 # Copyright (C) 2009-2011 the original author or authors.
3 # See the notice.md file distributed with this work for additional
4 # information regarding copyright ownership.
5 #
6 # Licensed under the Apache License, Version 2.0 (the "License");
7 # you may not use this file except in compliance with the License.
8 # You may obtain a copy of the License at
9 #
10 # http://www.apache.org/licenses/LICENSE-2.0
11 #
12 # Unless required by applicable law or agreed to in writing, software
13 # distributed under the License is distributed on an "AS IS" BASIS,
14 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 # See the License for the specific language governing permissions and
16 # limitations under the License.
17
18 title: Building
19 --- name:overview
20
21 # How to Build ${project_name}
22 The way most developers get started contributing to a project.
23
24 --- name:content
25
26 ## Building with Maven
27
28 ${project_name} uses [Maven](http://maven.apache.org/) as its primary
29 build tool for performing releases and uses the pom.xml to describe
30 dependencies between modules.
31
32 ### Prequisites
33
34 *Required:*
35
36 * Java 1.6
37 * Download and [install Maven 3](http://maven.apache.org/download.html)
38 * Get the latest [source](source.html)
39
40 ### Maven options
41
42 To build ${project_name} Maven has to be configured to use more memory
43
44 set MAVEN_OPTS=-Xmx512m -XX:MaxPermSize=128m
45
46 ### A normal build
47
48 mvn install
49
50 Once the build completes, you will find the binary distribution of
51 ${project_name} located in the `hawtjni-distro/target` directory.
52
53
54 ### Doing a Quick Build
55
56 The following avoids running all the unit test cases, we just skip the
57 test running phase and not the building part
58
59 mvn -Dtest=false install
60
61 ### Using an IDE
62
63 If you prefer to use an IDE then you can auto-generate the IDE's project
64 files using Maven plugins. e.g.
65
66 mvn eclipse:eclipse
67
68 or
69
70 mvn idea:idea
71
72 ### Importing into Eclipse
73
74 If you have not already done so, you will need to make Eclipse aware of
75 the Maven repository so that it can build everything. In the preferences,
76 go to `Java -> Build Path -> Classpath` and define a new Classpath
77 Variable named `M2_REPO` that points to your local Maven repository. i.e.
78 `~/.m2/repository` on Unix and `c:\Documents and Settings\$username\.m2\repository`
79 on Windows).
80
81 You can also get Maven to do this for you:
82
83 mvn eclipse:add-maven-repo -Declipse.workspace=/path/to/the/workspace/
84
85 ### See Also
86
87 * [Source](source.html)
88 * [Developer Links](developers.html)