New HACKING file.

2 files changed, 24 insertions, 25 deletions

diff --git a/HACKING b/HACKING
new file mode 100644
index 0000000..d57be49
--- /dev/null
+++ b/HACKING
@@ -0,0 +1,24 @@
+Here's an overview of how the code is arranged:
+
+Client (GPLv3):
+===============
+
+ENTRY POINT:         dimension/main.c
+Tokenizing:          dimension/lexer.l
+Language directives: dimension/tokenize.c
+Parsing:             dimension/common.rules
+Extra parsing stuff: dimension/{common,grammar,directives}.*
+Tests:               tests/dimension/*.{pov,sh}
+Benchmarks:          bench/dimension/*.{sh,pov}
+
+Library (LGPLv3):
+=================
+
+API:                   libdimension/dimension.h, libdimension/dimension/*.h
+                       (Implementations for libdimension/dimension/$file.h
+                       are generally at libdimension/$file.c)
+Ray tracing algorithm: libdimension/raytrace.c
+Bounding hierarchy:    libdimension/prtree.{c,h}
+Library internals:     libdimension/dimension-impl.h and its #includes
+Tests:                 tests/libdimension/*.{c,cpp}
+Benchmarks:            bench/libdimension/*.c
diff --git a/README b/README
index 8b891d6..b998a2e 100644
--- a/README
+++ b/README
@@ -7,28 +7,3 @@ look at tests/dimension/demo.{pov,png}.
 Documentation for the `dimension' program will eventually be in the doc/
 directory.  (Out of date) API documentation for the ray tracing library
 libdimension is also in doc/.
-
-Source-level documentation is found, well, in the source code.  To know where
-to look, refer to this mapping:
-
-Client (GPLv3):
-===============
-
-ENTRY POINT:         dimension/main.c
-Tokenizing:          dimension/lexer.l
-Language directives: dimension/tokenize.c
-Parsing:             dimension/common.rules
-Extra parsing stuff: dimension/{common,grammar,directives}.*
-Tests:               tests/dimension/*.{pov,sh}
-
-Library (LGPLv3):
-=================
-
-API:                   libdimension/dimension.h, libdimension/dimension/*.h
-                       (Implementations for libdimension/dimension/$file.h
-                       are generally at libdimension/$file.c)
-Ray tracing algorithm: libdimension/raytrace.c
-Bounding hierarchy:    libdimension/prtree.{c,h}
-Library internals:     libdimension/dimension-impl.h and its #includes
-Tests:                 tests/libdimension/*.{c,cpp}
-Benchmarks:            bench/libdimension/*.c