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  - rapidxml
  25
  26 You also need to apply a patch on /usr/share/bison/glr.c, the patch can be
  27 found in patches/
  28
  29 Folders:
  30 ========
  31
  32 cmake/                                          cmake macros
  33 doc/                                            the documentation folder
  34 doc/html                                        the generated doxygen html files
  35 patches/                                        patches for upstream sources
  36 po/                                             contains translations
  37 src/                                            the source folder
  38 src/moulette                                    the moulette folder
  39 src/moulette/bison                              the moulette's test parser
  40 src/moulette/listeners                          listeners for the moulette
  41 src/moulette/tests                              tests engines for the moulette
  42 src/ozulis                                      the root of ozulis sources
  43 src/ozulis/ast                                  ast related tools
  44 src/ozulis/core                                 generic stuff
  45 src/ozulis/generators                           some stuff to generate code
  46 src/ozulis/visitors                             type checker, simplifer, llvm generator, ...
  47 src/plugins                                     ozulis' plugins
  48 src/plugins/lang                                language plugins
  49 src/plugins/lang/mugiwara                       the mugiwara parser
  50 src/plugins/lang/mugiwara/bison                 bison stuff for mugiwara