README

   1 ________               .__   .__
   2 \_____  \ __________ __|  |  |__| ______
   3  /   |   \\___   /  |  \  |  |  |/  ___/
   4 /    |    \/    /|  |  /  |__|  |\___ \
   5 \_______  /_____ \____/|____/|__/____  >
   6         \/      \/                   \/
   7
   8 Description:
   9 ============
  10
  11 This project is mainly an experimental compiler for experimental languages.
  12 It provides a common AST and works with modules not #include like in C or C++.
  13 More description will come later.
  14
  15 Dependancies:
  16 =============
  17
  18  - C++0x compiler
  19  - cmake
  20  - boost
  21  - bison
  22  - flex
  23  - bohem gc (C/C++ garbage collector)
  24
  25 You also need to apply a patch on /usr/share/bison/glr.c, the patch can be
  26 found in patches/
  27
  28 Folders:
  29 ========
  30
  31 doc/                                            the documentation folder
  32 doc/html                                        the generated doxygen html files
  33 patches/                                        patches for upstream sources
  34 src/                                            the source folder
  35 src/moulette                                    the moulette folder
  36 src/moulette/bison                              the moulette's test parser
  37 src/moulette/listeners                          listeners for the moulette
  38 src/moulette/tests                              tests engines for the moulette
  39 src/ozulis                                      the root of ozulis sources
  40 src/ozulis/ast                                  ast related tools
  41 src/ozulis/core                                 generic stuff
  42 src/ozulis/generators                           some stuff to generate code
  43 src/ozulis/visitors                             type checker, simplifer, llvm generator, ...
  44 src/plugins                                     ozulis' plugins
  45 src/plugins/lang                                language plugins
  46 src/plugins/lang/mugiwara                       the mugiwara parser
  47 src/plugins/lang/mugiwara/bison-parser          bison stuff for mugiwara