aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 14 insertions, 5 deletions
diff --git a/README.md b/README.md
index 95a0672..95bb22d 100644
--- a/README.md
+++ b/README.md
@@ -3,24 +3,33 @@
3A simple adventure game made as part of unit IGI-1002 (Java) at ESIEE Paris. 3A simple adventure game made as part of unit IGI-1002 (Java) at ESIEE Paris.
4 4
5 5
6## Project resources
7
8The maps, the scenario, the planning and other resources are stored on [Google Drive](https://drive.google.com/folderview?id=0B1_LKCFPsrpyQXNieUlNSEhYOU0&usp=sharing).
9
10
6## Repository structure 11## Repository structure
7 12
8- /game: the BlueJ project 13- /src: the Java source code
14- /res: non Java resources to be included in the .jar
15- /war: HTML, CSS and JS related to the web app
16- /test: command test text files
9- /website: the project's website 17- /website: the project's website
10- /report: the LaTeX project report 18- /report: the LaTeX project report
11 19
12 20
13## Continuous integration 21## Continuous integration
14 22
15The website, the LaTeX report, the .jar and the Javadoc are automagically generated through Gitlab CI and published on the [project's website](http://esieequest.pacien.net/). 23The website, the LaTeX report, the .jar, the Javascript web app and the Javadoc are automagically generated through Gitlab CI and published on the [project's website](http://esieequest.pacien.net/).
16 24
17 25
18## Code guidelines 26## Code guidelines
19 27
20For the conventions, see the ["Objects First With Java" style guide](http://www.esiee.fr/~bureaud/Unites/BlueJ/OFWJ-styleguide.htm). 28For the conventions, see the ["Objects First With Java" style guide](http://www.bluej.org/objects-first/styleguide.html).
21
22Also use the Eclipse code formatter, and tabs instead of spaces for indentation.
23 29
30Also use the Eclipse code formatter, tabs instead of spaces for indentation and opening curly braces on the same line.
31Do not use prefixes such as "a", "p", "v" or "pkg_" on variables and packages.
32Try to use "final" and "this." as often as possible.
24 33
25## Authors 34## Authors
26 35