src/README

   1 This is preliminary version of the Rust compiler.
   2
   3 Source layout:
   4
   5 boot/              The bootstrap compiler
   6 boot/fe            - Front end (lexer, parser, AST)
   7 boot/me            - Middle end (resolve, check, layout, trans)
   8 boot/be            - Back end (IL, RA, insns, asm, objfiles)
   9 boot/util          - Ubiquitous helpers
  10 boot/llvm          - LLVM-based alternative back end
  11 boot/driver        - Compiler driver
  12
  13 comp/              The self-hosted compiler (doesn't exist yet)
  14 comp/*             - Same structure as in boot/
  15
  16 rt/                The runtime system
  17 rt/rust_*.cpp      - The majority of the runtime services
  18 rt/isaac           - The PRNG used for pseudo-random choices in the runtime
  19 rt/bigint          - The bigint library used for the 'big' type
  20 rt/uthash          - Small hashtable-and-list library for C, used in runtime
  21 rt/{sync,util}     - Small utility classes for the runtime.
  22
  23 test/              Testsuite (for both bootstrap and self-hosted)
  24 test/compile-fail  - Tests that should fail to compile
  25 test/run-fail      - Tests that should compile, run and fail
  26 test/run-pass      - Tests that should compile, run and succeed
  27
  28 Please be gentle, it's a work in progress.