Add a boot/README file explaining rustboot's organization a bit.

rust-lang · Jul 11, 2010 · 30c4070 · 30c4070
1 parent 2eafd28
commit 30c4070
Show file tree

Hide file tree

Showing 3 changed files with 407 additions and 1 deletion.
diff --git a/src/Makefile b/src/Makefile
@@ -728,7 +728,7 @@ PKG_3RDPARTY := rt/valgrind.h rt/memcheck.h \
                 rt/uthash/uthash.h rt/uthash/utlist.h \
                 rt/bigint/bigint.h rt/bigint/bigint_int.cpp \
                 rt/bigint/bigint_ext.cpp rt/bigint/low_primes.h
-PKG_FILES := README \
+PKG_FILES := README boot/README \
              $(wildcard etc/*.*) \
              $(MKFILES) $(BOOT_MLS) boot/fe/lexer.mll \
              $(COMPILER_INPUTS) \

diff --git a/src/README b/src/README
@@ -3,6 +3,7 @@ This is preliminary version of the Rust compiler.
 Source layout:
 
 boot/              The bootstrap compiler
+boot/README        - More-detailed guide to it.
 boot/fe            - Front end (lexer, parser, AST)
 boot/me            - Middle end (resolve, check, layout, trans)
 boot/be            - Back end (IL, RA, insns, asm, objfiles)