Browse code

update documentation

devnewton authored on 28/07/2014 at 08:09:27
Showing 2 changed files
... ...
@@ -2,47 +2,22 @@ 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
-Compile
8
-=======
9
-
10
-Go to the source folder and run maven with the following command:
8
+Build
9
+=====
11 10
 
12
-	mvn package
11
+Go to the source folder and run the build.sh script using bash:
13 12
 
14
-This will generate an executable jar in target subfolder named nedetlesmaki-lwjgl-${project.version}.jar
13
+	bash build.sh
15 14
 
16 15
 Install
17 16
 =======
18 17
 
19
-Manual installation
20
-
21
-- Create a directory, for example /opt/nedetlesmaki-lwjgl
22
-- Copy the game/lwjgl/target/nedetlesmaki-lwjgl-${project.version}.jar, the game/lwjgl/target/natives, game/lwjgl/target/lib and assets folders into it.
23
-
24
-Create packages and installers
25
-
26
-Using maven 3 plugins, rpm and deb can be generated and also a generic [izpack](www.izpack.org) based installer.
27
-
28
-	mvn clean package -Pizpack,deb,rpm
29
-
30
-Run
31
-===
32
-
33
-
34
-The game can be run using the following command:
35
-
36
-	java -jar nedetlesmaki-lwjgl-${project.version}.jar
37
-
38
-It will try to load the game data files in
39
-
40
-	./assets
41
-
42
-or
18
+The build.sh script generate installers for various OS in the target/release subfolder. Use them to install the game.
43 19
 
44
-	../assets
20
+Develop, debug, contribute
21
+==========================
45 22
 
46
-NB: lwjgl shared libraries must be loadable, check the [lwjgl](www.lwjgl.org) documentation for more information.
23
+Please contact us
47 24
\ No newline at end of file
... ...
@@ -1,13 +1,18 @@
1
-# Ned et les maki
1
+Ned et les maki
2
+===============
2 3
 
3
-[![build status](http://gitlabci.pierre.marijon.fr/projects/5/status.png?ref=master)](http://gitlabci.pierre.marijon.fr/projects/5?ref=master)
4
+Ned et les maki is an opensource puzzle game with isometric 3d graphics inspired by Sokoban.
4 5
 
5
-## Branch
6
+[Official site](http://en.geekygoblin.org/ned-et-les-maki)
6 7
 
7
-master branch is in developement, not stable.
8
+[Build instructions](INSTALL.md)
8 9
 
9
-Branch v0.2 is the last stable version.
10
+![Screenshot](assets/menu.png)
10 11
 
11
-## Bug report
12
+Bug report
13
+----------
12 14
 
13 15
 For bug report, you can login in http://dev.geekygoblin.org with username : anonymous and password : anonymous
16
+
17
+[![build status](http://gitlabci.pierre.marijon.fr/projects/5/status.png?ref=master)](http://gitlabci.pierre.marijon.fr/projects/5?ref=master)
18
+