From af3b4b5671330a587cefc4f20bf86f8f162293e5 Mon Sep 17 00:00:00 2001 From: Pacien TRAN-GIRARD Date: Sun, 16 Mar 2014 16:20:58 +0100 Subject: Update README --- README.md | 19 ++++++++++++++----- 1 file 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 @@ A simple adventure game made as part of unit IGI-1002 (Java) at ESIEE Paris. +## Project resources + +The maps, the scenario, the planning and other resources are stored on [Google Drive](https://drive.google.com/folderview?id=0B1_LKCFPsrpyQXNieUlNSEhYOU0&usp=sharing). + + ## Repository structure -- /game: the BlueJ project +- /src: the Java source code +- /res: non Java resources to be included in the .jar +- /war: HTML, CSS and JS related to the web app +- /test: command test text files - /website: the project's website - /report: the LaTeX project report ## Continuous integration -The 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/). +The 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/). ## Code guidelines -For the conventions, see the ["Objects First With Java" style guide](http://www.esiee.fr/~bureaud/Unites/BlueJ/OFWJ-styleguide.htm). - -Also use the Eclipse code formatter, and tabs instead of spaces for indentation. +For the conventions, see the ["Objects First With Java" style guide](http://www.bluej.org/objects-first/styleguide.html). +Also use the Eclipse code formatter, tabs instead of spaces for indentation and opening curly braces on the same line. +Do not use prefixes such as "a", "p", "v" or "pkg_" on variables and packages. +Try to use "final" and "this." as often as possible. ## Authors -- cgit v1.2.3