aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorPacien TRAN-GIRARD2014-02-05 22:37:47 +0100
committerPacien TRAN-GIRARD2014-02-05 22:37:47 +0100
commit8c90c3d2046413914516e40a02c01891824f1683 (patch)
treef21b5e4ee999c81021769d940a3c8ac5ea3096ac /README.md
downloadesieequest-8c90c3d2046413914516e40a02c01891824f1683.tar.gz
Add README
Diffstat (limited to 'README.md')
-rw-r--r--README.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..95a0672
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@
1# ESIEEquest
2
3A simple adventure game made as part of unit IGI-1002 (Java) at ESIEE Paris.
4
5
6## Repository structure
7
8- /game: the BlueJ project
9- /website: the project's website
10- /report: the LaTeX project report
11
12
13## Continuous integration
14
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/).
16
17
18## Code guidelines
19
20For the conventions, see the ["Objects First With Java" style guide](http://www.esiee.fr/~bureaud/Unites/BlueJ/OFWJ-styleguide.htm).
21
22Also use the Eclipse code formatter, and tabs instead of spaces for indentation.
23
24
25## Authors
26
27Group 3F:
28
29- Pacien TRAN-GIRARD
30- BenoƮt LUBRANO DI SBARAGLIONE