- Currently there's not a great deal in the way of documentation
- for mLib. The header and source files are fairly verbosely
- commented, though, and you shouldn't go far wrong if you just
- read the function descriptions in the header. I'm working on a
- proper set of manual pages for the whole thing, but don't hold
- your breath.
+
+Documentation
+
+ There is now a (hopefully fairly good) set of manual pages for
+ mLib. The manual isn't installed by default since it takes a
+ while to install and it's not a very good idea when it's part
+ of a larger package. To install the manual pages, say
+
+ make install-man
+
+ (after everything else is built, obviously).
+
+ There's also documentation in the header files. The header file
+ comments were, in general, written at the same time as the code.
+ This has the disadvantage that they focus at a fairly low level,
+ and use terminology relating to the implementation rather than
+ the interface.
+
+ The header file comments can be handy for quick browsing.
+ However, the manual pages are considered the authoritative
+ source of information about the programming interface. If you
+ have to look at the source code, it usually means that my
+ documentation or interface design is wrong.