-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Rodrigo Alves Vieira
committed
Apr 27, 2013
1 parent
6e078ca
commit 2863f9e
Showing
1 changed file
with
15 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -8,20 +8,24 @@ Groundhog uses Java 7 features, so you must have it installed before build. | |
|
||
### Building in your machine | ||
|
||
Groundhog was built using Maven. In order for it to behave like an Eclipse project, you'll need to install [1] Maven, and then run: | ||
Groundhog was built using Maven, so to build the project you will need to run the tool and let it fetch all the dependencies: | ||
|
||
``` | ||
$ mvn eclipse:eclipse | ||
$ mvn package | ||
``` | ||
|
||
### Generating the JAR | ||
### Bulding for Eclipse | ||
|
||
Generate the JAR file for the Groundhog project. | ||
In order for it to behave like an Eclipse project, you'll need to install the Maven plugin and then run: | ||
|
||
``` | ||
$ mvn package | ||
$ mvn eclipse:eclipse | ||
``` | ||
|
||
### Generating the JAR | ||
|
||
Generate the JAR file for the Groundhog project. | ||
|
||
Eclipse users can go to `File > Export > Runnable Jar File` and enter the `CmdMain` class for the option "Launch Configuration". | ||
|
||
### Running Groundhog | ||
|
@@ -77,23 +81,21 @@ $ javadoc -d src/src/groundhog br.cin.ufpe.groundhog | |
* Rodrigo Alves Vieira {[email protected]} | ||
|
||
* Danilo Neves Ribeiro {[email protected]} | ||
|
||
* Fernando Castor {[email protected]} | ||
|
||
## How to contribute | ||
|
||
Want to contribute with code, documentation or bug report? | ||
Want to contribute with code, documentation or bug report? That's great, check out the [Issues] page. | ||
|
||
Preferably, your contribution is followed by JUnit tests and the submitted code is in agreement | ||
|
||
Just add an issue and fix them! :) | ||
Try the [existing ones](https://github.com/spgroup/groundhog/issues) | ||
Stability and maintainability are important goals of the Groundhog project. Well-written, tested code and proper documentation are very welcome. | ||
|
||
## License | ||
|
||
Groundhog is released under GPL 2. | ||
|
||
[1]: Consider installing the [m2e] plugin for Eclipse | ||
|
||
[GitHub API v3]: http://developer.github.com/ | ||
[m2e]: http://eclipse.org/m2e/ | ||
[Wiki]: https://github.com/spgroup/groundhog/wiki | ||
======= | ||
[Issues]: https://github.com/spgroup/groundhog/issues |