Document something about doxygen

diff --git a/IMPORTANT b/IMPORTANT
index a33219321a7d4025a417dcd10cfe58cdd65b5ba7..a3e1bd2cbd4f86b111ba29b1c80cf0cc2bfb2e70 100644 (file)
--- a/IMPORTANT
+++ b/IMPORTANT
@@ -19,6 +19,11 @@ Create an Xcode project for use on OS X.
 
 Used for cross-compiling for Windows using MinGW.
 
+       make documentation
+
+Setup a `doxygen` configuration file based on project information, and then
+generate HTML and LaTeX documentation.
+
        make clean
 
 Clean up the `build` directory.

diff --git a/README.md b/README.md
index 994a00e3baf0ed1925b6eaa94c39d656efb1653d..a609df5de0202184c5fb1334b326f057a7b63281 100644 (file)
--- a/README.md
+++ b/README.md
@@ -28,11 +28,17 @@ Additionally, I wanted to try to start encouraging some "better practices"
        `cmake` to combine those elements to ensure consistency across source
        code and README files.
 
+4.     Documentation -- some default setup to allow for [doxygen]-generated
+       documentation.  The generated `README.md` file is used as the main 
+       page, and the source c/header files are included.  Naturally, doxygen
+       is a complex system, so you're responsible for figuring out how to 
+       properly document your code.
 
 
 [tdd]: https://en.wikipedia.org/wiki/Test-driven_development
 [cmake]:       http://www.cmake.org/
 [CuTest]:      http://cutest.sourceforge.net
+[doxygen]:     http://www.stack.nl/~dimitri/doxygen/
 
 
 # How do I use it? #