about summary refs log tree commit diff stats
diff options
context:
space:
mode:
authorKartik K. Agaram <vc@akkartik.com>2015-04-24 08:55:12 -0700
committerKartik K. Agaram <vc@akkartik.com>2015-04-24 08:55:12 -0700
commitd77a5ccce9028e9c43a886d4246bd032f1c15a70 (patch)
tree3a61f97a87254b993a3e3721a47bcc3c407c70f7
parent6ace03638fa924156fa77733274ae646f8fa3dbe (diff)
downloadmu-d77a5ccce9028e9c43a886d4246bd032f1c15a70.tar.gz
1158
-rw-r--r--cpp/000organization29
1 files changed, 15 insertions, 14 deletions
diff --git a/cpp/000organization b/cpp/000organization
index bf017d16..5cde369b 100644
--- a/cpp/000organization
+++ b/cpp/000organization
@@ -11,17 +11,17 @@
 //: cycle. Doing one well makes it easier to do the other.
 //:
 //: Lower down, this file contains a legal, bare-bones C++ program. It doesn't
-//: do anything yet; subsequent files or 'layers' will contain directives to
-//: inserting lines into it. For example:
+//: do anything yet; subsequent files will contain :(...) directives to insert
+//: lines into it. For example:
 //:   :(after "more events")
-//: This will insert the following lines after a line in the program containing
-//: the words "more events".
+//: This directive means: insert the following lines after a line in the
+//: program containing the words "more events".
 //:
-//: A simple tool will 'tangle' all the layers together according to the
-//: directives into a single source file containing all the code for the
-//: project, and then feed the source file to the compiler. (It'll drop these
-//: comments starting with a '//:' prefix that only make sense in the context
-//: of layers.)
+//: A simple tool is included to 'tangle' all the files together in sequence
+//: according to their directives into a single source file containing all the
+//: code for the project, and then feed the source file to the compiler.
+//: (It'll drop these comments starting with a '//:' prefix that only make
+//: sense before tangling.)
 //:
 //: Directives free up the programmer to order code for others to read rather
 //: than as forced by the computer or compiler. Each individual feature can be
@@ -70,11 +70,12 @@
 //: Here's part of a layer in color: http://i.imgur.com/0eONnyX.png. Directives
 //: are shaded dark.
 //:
-//: Layers do more than just shuffle code around. Past the initial skeleton of
-//: this program (currently 00*-02*), it ought to be possible to stop loading
-//: after any file/layer, build and run the program, and pass all tests for
-//: loaded features. (Relevant is http://youtube.com/watch?v=c8N72t7aScY, a
-//: scene from "2001: A Space Odyssey".)
+//: Layers do more than just shuffle code around. Their guarantee is that it
+//: should be possible to stop loading after any file/layer, build and run the
+//: program, and pass all tests for loaded features. (Relevant is
+//: http://youtube.com/watch?v=c8N72t7aScY, a scene from "2001: A Space
+//: Odyssey".) Use the included script called 'test_all' to check the
+//: guarantee if you make any changes.
 //:
 //: This 'subsetting guarantee' ensures that this directory contains a
 //: cleaned-up narrative of the evolution of this codebase. Organizing