0.11. Standalone installation of Glasgow literate programming

Here are some short notes; they should work on a Sun4:

• 1. If you don't have `perl', go get it.

• 2. If you don't have `makeindex' (normally with the TeX distribution) and/or `tgrind', go get them, if you wish. You can easily get by without them, especially `tgrind'.

• 3. Customise for your local configuration, by creating a suitable `mkworld/site.jm' file. We supply a `site.dist' file that you can copy and work from.

  Setting `PerlCmd' correctly is vital.

  All the Haskell-compiler stuff isn't important for the literate-programming system.

  Setting `TgrindHelperCmd' is important if you're going to try the tgrind-ing stuff.

  Setting the things for installation (near the end) is vital. You will almost certainly need to set `InstRootDir', and perhaps some others. If you don't set anything, the literate-programming system will be installed (on a Sun4) in...

  /usr/local/bin/sun4 things for the user to invoke (lit2mumble)

  /usr/local/lib/literate/sun4 machine-specific support stuff

  /usr/local/lib/literate machine-independent support stuff

• 4. OK, you should be ready to go! From the top of the distribution...
  % cd lit2xxx-X.YY

  % ./STARTUP-literate >& startup.log

  Everything should proceed to an obviously-successful conclusion (check the log to see...).

• 5. Test the system enough to see that it's not totally broken. Invoke `lit2pgm', `lit2latex', or `lit2texi' directly from the `literate/' directory, on some small test file of your choice, even something as simple as...:
  \section[test]{Test section}

  This is a small test.

  Then try, perhaps:
  % literate/lit2latex -v -c test.lit

• 6. If things seem basically happy, you can safely install the system.
  % cd literate

  % make -n install # trial run, just to see if it looks "right"

  % make install # for real!

• 7. To make the documentation (some pre-built stuff is in the distrib):
  % cd literate

  % make literate.dvi # or ...

  % make literate.info # or ...

  % make docs # to do both

  In the unlikely event you wanted to install it, continue with:
  % make install-docs

• 8. You can now either delete the source or just clean up:
  % make clean

• 9. Save a copy of your configuration file `mkworld/site.jm' for next time.