summaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorTavian Barnes <tavianator@gmail.com>2010-10-29 01:58:23 -0400
committerTavian Barnes <tavianator@gmail.com>2010-10-29 01:58:23 -0400
commite17db7ee6be3c56796394c96a79d267e6858cf59 (patch)
tree82d90726e5a2bf42645c2c47345554122696d779 /README
parentdb0b35dcfaa2a77500393d917a2a1ef598b8bf36 (diff)
downloaddimension-e17db7ee6be3c56796394c96a79d267e6858cf59.tar.xz
New HACKING file.
Diffstat (limited to 'README')
-rw-r--r--README25
1 files changed, 0 insertions, 25 deletions
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