4.13 Writing Documentation

The format of the documentation is described in chapter Manual format. The documentation files provided with the share package must contain the manual.tex file to actually run TeX over the manual, the separate TeX files for the manual chapters and the file manual.six, produced by running TeX. This file is used by the online help to get the index information. It may also be helpful to add a preTeXed dvi or ps file of the package's manual.

The main directory of the share package should also contain a file INSTALL or README that tells the user shortly what the share package does and (if applicable) how to compile and install binaries.

[Top] [Previous] [Up] [Next] [Index]

GAP 4 manual
February 2000