diff options
author | Kartik K. Agaram <vc@akkartik.com> | 2017-10-04 22:38:22 -0700 |
---|---|---|
committer | Kartik K. Agaram <vc@akkartik.com> | 2017-10-04 22:38:22 -0700 |
commit | 36f616b5c011e32e4a8be1a4864f81e11424de89 (patch) | |
tree | efacd252ae493f3d63b5aa82df49bc3cb138c6ed /000organization.cc | |
parent | 984a6321ad3dd5a20797cbd8cba800081bf56ad4 (diff) | |
download | mu-36f616b5c011e32e4a8be1a4864f81e11424de89.tar.gz |
4010
Diffstat (limited to '000organization.cc')
-rw-r--r-- | 000organization.cc | 32 |
1 files changed, 16 insertions, 16 deletions
diff --git a/000organization.cc b/000organization.cc index b795d8ab..d9f072f9 100644 --- a/000organization.cc +++ b/000organization.cc @@ -79,14 +79,14 @@ //: //: This 'subsetting guarantee' ensures that this directory contains a //: cleaned-up narrative of the evolution of this codebase. Organizing -//: autobiographically allows a newcomer to rapidly orient himself, reading the -//: first few files to understand a simple gestalt of a program's core purpose -//: and features, and later gradually working his way through other features as -//: the need arises. -//: -//: Programmers shouldn't need to understand everything about a program to hack -//: on it. But they shouldn't be prevented from a thorough understanding of -//: each aspect either. The goal of layers is to reward curiosity. +//: autobiographically allows a newcomers to rapidly orient themselves, +//: reading the first few files to understand a simple gestalt of a program's +//: core purpose and features, and later gradually working their way through +//: other features as the need arises. +//: +//: Programmers shouldn't need to understand everything about a program to +//: hack on it. But they shouldn't be prevented from a thorough understanding +//: of each aspect either. The goal of layers is to reward curiosity. // Includes // End Includes @@ -94,19 +94,19 @@ // Types // End Types -// Prototypes are auto-generated in the 'build' script; define your functions -// in any order. Just be sure to declare each function header all on one line. -// Our auto-generation scripts are too minimal and simple-minded to handle -// anything else. +// Function prototypes are auto-generated in the 'build' script; define your +// functions in any order. Just be sure to declare each function header all on +// one line, ending with the '{'. Our auto-generation scripts are too minimal +// and simple-minded to handle anything else. #include "function_list" // by convention, files ending with '_list' are auto-generated // Globals // // All statements in this section should always define a single variable on a // single line. The 'build' script will simple-mindedly auto-generate extern -// declarations for them. Don't forget to define (not just declare) constants -// with extern linkage in this section, since C++ global constants have -// internal linkage by default. +// declarations for them. Remember to define (not just declare) constants with +// extern linkage in this section, since C++ global constants have internal +// linkage by default. // // End Globals @@ -124,7 +124,7 @@ int main(int argc, char* argv[]) { // Unit Tests // End Unit Tests -//: our first directive; will move the include above the program +//: our first directive; insert the following header at the start of the program :(before "End Includes") #include <stdlib.h> |