summaryrefslogtreecommitdiff
path: root/tiger-compiler/src/doc.hh
diff options
context:
space:
mode:
Diffstat (limited to 'tiger-compiler/src/doc.hh')
-rw-r--r--tiger-compiler/src/doc.hh23
1 files changed, 23 insertions, 0 deletions
diff --git a/tiger-compiler/src/doc.hh b/tiger-compiler/src/doc.hh
new file mode 100644
index 0000000..e629911
--- /dev/null
+++ b/tiger-compiler/src/doc.hh
@@ -0,0 +1,23 @@
+/**
+
+\mainpage
+
+These pages document the implementation of the EPITA Tiger Compiler
+Project (http://tiger.lrde.epita.fr).
+
+This very important project in the EPITA curriculum consists in the
+implementation of a Tiger compiler in C++. The Tiger language is
+described by Andrew Appel in his "Modern Compiler Implementation"
+books.
+
+Most of the material students need to implement their Tiger Project is
+to be found in the http://www.lrde.epita.fr/~tiger/ directory. In
+particular, reading http://www.lrde.epita.fr/~tiger/assignments.html
+is mandatory.
+
+The reader will find more information in various places listed on
+http://tiger.lrde.epita.fr/.
+
+*/
+
+Local Variables : mode : text End: