diff options
| author | Adrien Tétar <adri-from-59@hotmail.fr> | 2014-01-11 15:19:38 +0100 |
|---|---|---|
| committer | Adrien Tétar <adri-from-59@hotmail.fr> | 2014-01-11 19:41:31 +0100 |
| commit | a30d61b05a7b11bcc52c2d4988c0a5f7fedce2ff (patch) | |
| tree | f2ff04b7d13f270cd99569a0da8a9976a10f9a7b /src/README.md | |
| parent | 01794cc993a1f00ca2bc82498b256a88556a4e83 (diff) | |
| download | rust-a30d61b05a7b11bcc52c2d4988c0a5f7fedce2ff.tar.gz rust-a30d61b05a7b11bcc52c2d4988c0a5f7fedce2ff.zip | |
Various READMEs and docs cleanup
Noticeably closes #11428.
Diffstat (limited to 'src/README.md')
| -rw-r--r-- | src/README.md | 43 |
1 files changed, 43 insertions, 0 deletions
diff --git a/src/README.md b/src/README.md new file mode 100644 index 00000000000..b3751e56c03 --- /dev/null +++ b/src/README.md @@ -0,0 +1,43 @@ +This is a preliminary version of the Rust compiler, libraries and tools. + +Source layout: + +| `librustc/` | The self-hosted compiler | +| `libstd/` | The standard library (imported and linked by default) | +| `libextra/` | The "extras" library (slightly more peripheral code) | +| `libsyntax/` | The Rust parser and pretty-printer | +| ------------------- | --------------------------------------------------------- | +| `rt/` | The runtime system | +| `rt/rust_*.c` | - The majority of the runtime services | +| `rt/isaac` | - The PRNG used for pseudo-random choices in the runtime | +| `rt/bigint` | - The bigint library used for the 'big' type | +| `rt/uthash` | - Small hashtable-and-list library for C, used in runtime | +| `rt/sync` | - Concurrency utils | +| `rt/util` | - Small utility classes for the runtime. | +| `rt/vg` | - Valgrind headers | +| `rt/msvc` | - MSVC support | +| ------------------- | --------------------------------------------------------- | +| `test/` | Testsuite | +| `test/compile-fail` | - Tests that should fail to compile | +| `test/run-fail` | - Tests that should compile, run and fail | +| `test/run-pass` | - Tests that should compile, run and succeed | +| `test/bench` | - Benchmarks and miscellaneous | +| `test/pretty` | - Pretty-printer tests | +| `test/auxiliary` | - Dependencies of tests | +| ------------------- | --------------------------------------------------------- | +| `compiletest/` | The test runner | +| ------------------- | --------------------------------------------------------- | +| `librustpkg/` | The package manager and build system | +| ------------------- | --------------------------------------------------------- | +| `librustdoc/` | The Rust API documentation tool | +| ------------------- | --------------------------------------------------------- | +| `llvm/` | The LLVM submodule | +| ------------------- | --------------------------------------------------------- | +| `libuv/` | The libuv submodule | +| ------------------- | --------------------------------------------------------- | +| `rustllvm/` | LLVM support code | +| ------------------- | --------------------------------------------------------- | +| `libfuzzer/` | A collection of fuzz testers | +| ------------------- | --------------------------------------------------------- | +| `etc/` | Scripts, editors support, misc | + |