Added Gradle instructions to the readme
This commit is contained in:
parent
dea0104c4d
commit
d6d82333c3
11
README.md
11
README.md
|
@ -38,8 +38,17 @@ other game options can be accessed by clicking the "Other Options" button in
|
||||||
the song menu.
|
the song menu.
|
||||||
|
|
||||||
## Building
|
## Building
|
||||||
opsu! is distributed as a Maven project.
|
opsu! is distributed as both a Maven and Gradle project.
|
||||||
|
|
||||||
|
### Gradle
|
||||||
|
Gradle builds are built to the `build` directory.
|
||||||
|
* To run the project, execute the Gradle task `run`.
|
||||||
|
* To create a single executable JAR file, execute the Gradle task
|
||||||
|
`build`. This will compile a jar to `build/libs/opsu-${version}.jar` with
|
||||||
|
the libraries, resources and natives packed inside the jar.
|
||||||
|
|
||||||
|
### Maven
|
||||||
|
Maven builds are built to the `target` directory.
|
||||||
* To run the project, execute the Maven goal `compile exec:exec`.
|
* To run the project, execute the Maven goal `compile exec:exec`.
|
||||||
* To create a single executable JAR file, execute the Maven goal
|
* To create a single executable JAR file, execute the Maven goal
|
||||||
`install -Djar`. This will link the LWJGL native libraries using a
|
`install -Djar`. This will link the LWJGL native libraries using a
|
||||||
|
|
|
@ -92,6 +92,8 @@ jar {
|
||||||
|
|
||||||
from { configurations.compile.collect { it.isDirectory() ? it : zipTree(it) } }
|
from { configurations.compile.collect { it.isDirectory() ? it : zipTree(it) } }
|
||||||
exclude '**/Thumbs.db'
|
exclude '**/Thumbs.db'
|
||||||
|
|
||||||
|
dependsOn 'unpackNatives'
|
||||||
}
|
}
|
||||||
|
|
||||||
run {
|
run {
|
||||||
|
|
Loading…
Reference in New Issue
Block a user