Browse code

update doc

devnewton authored on 07/08/2014 at 21:21:07
Showing 2 changed files
... ...
@@ -2,30 +2,38 @@ Requirements
2 2
 ============
3 3
 
4 4
 Java JDK, [openjdk](http://openjdk.java.net/) or [Oracle](http://java.com): 1.7+
5
-[Maven](http://www.maven.org) 3+
5
+[Maven](http://www.maven.org) 3+,
6
+[bash](https://www.gnu.org/software/bash/) 4+
6 7
 
7
-Manual procedure
8
-================
8
+Build
9
+=====
9 10
 
10
-Compile
11
+Go to the source folder and run the build.sh script using bash:
11 12
 
12
-Go to the source folder and run maven with the following command:
13
+	bash build.sh
13 14
 
14
-	mvn package
15
+Install
16
+=======
15 17
 
16
-This will generate an executable jar installer in packages/generic/target subfolder named newton-adventure-installer-${project.version}.jar
18
+The build.sh script generate installers for various OS in the target/release subfolder. Use them to install the game.
17 19
 
18
-Install
20
+Run without install 
21
+===================
22
+
23
+Go to the source folder and run the play.sh script using bash:
24
+
25
+        bash play.sh
26
+
27
+Develop, debug
28
+==============
19 29
 
20
-Go to the source folder and launch the generic installer:
30
+Newton Adventure is maven based project, open it with Netbeans or Eclipse.
21 31
 
22
-    java -jar packages/generic/target/newton-adventure-installer-${project.version}.jar
32
+Contribute
33
+==========
23 34
 
24
-Create other packages and installers
35
+Please contact me:
25 36
 
26
-Using maven 3 plugins, rpm, deb and exe package/installer can be generated:
37
+- by mail: devnewton at bci.im
38
+- using IRC: #GGP on freenode.net.
27 39
 
28
-	mvn clean package -Pdeb,rpm,win
... ...
@@ -1,9 +1,12 @@
1
+Newton Adventure
2
+================
3
+
1 4
 Newton Adventure is a free and open source 2D platform game. You play Newton, a very special hero who has the power to change gravity direction.
2 5
 
3
-It runs on every Linux, Windows, Mac OS X or any OS with Java and OpenGL support.
6
+It runs on Linux, Windows, Mac OS X or any OS with Java and OpenGL support.
4 7
 
5 8
 Code is available under BSD licence, data under CC-BY-SA or more permissive licences.
6 9
 
7
-[Official website](http://devnewton.bci.im/games/newton_adventure)
10
+[Official website](http://newtonadventure.bci.im)
8 11
 
9 12
 ![screenshots](wiki/screenshots/montage_800_600.jpg)