From 169e9c192aac22ea87d257b0490dd2374956ec17 Mon Sep 17 00:00:00 2001 From: Jeffrey Han Date: Thu, 11 Sep 2014 17:36:43 -0400 Subject: [PATCH] Updated readme with Maven build information. (follow-up 54b5469, #7) Signed-off-by: Jeffrey Han --- README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index f35ac5fd..3bba4225 100644 --- a/README.md +++ b/README.md @@ -31,9 +31,13 @@ first time, or whenever hit objects are out of sync with the music. This and other game options can be accessed by clicking the wrench icon in the song menu. ## Building -The LWJGL native libraries must be linked and distributed with this application. -[JarSplice](http://ninjacave.com/jarsplice) is included in the tools directory -to merge the files into a single executable fat jar for distribution. +opsu! is distributed as a Maven project. + +* To run the project, execute the Maven goal `compile exec:exec`. +* To create a single executable JAR file, execute the Maven goal +`package shade:shade`. Note that the LWJGL native libraries must be linked and +distributed with this application; [JarSplice](http://ninjacave.com/jarsplice) +is included in the tools directory to merge the files into a fat jar. ## Credits This software was created by Jeffrey Han