From 8c90c3d2046413914516e40a02c01891824f1683 Mon Sep 17 00:00:00 2001
From: Pacien TRAN-GIRARD
Date: Wed, 5 Feb 2014 22:37:47 +0100
Subject: Add README

---
 README.md | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..95a0672
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@
+# ESIEEquest
+
+A simple adventure game made as part of unit IGI-1002 (Java) at ESIEE Paris.
+
+
+## Repository structure
+
+- /game: the BlueJ project
+- /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/).
+
+
+## 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.
+
+
+## Authors
+
+Group 3F:
+
+- Pacien TRAN-GIRARD
+- Benoît LUBRANO DI SBARAGLIONE
-- 
cgit v1.2.3