1# $Id: README,v 1.10 2007/06/14 14:02:42 dan Exp $
2
3--------------------------
4Quick overview
5--------------------------
6
7latex-mk is a set of makefile fragments designed to assist in the
8management of LaTeX documents.  The user creates a simple Makefile
9which sets up a few simple variables and then includes the latex.mk
10fragment at the end.  Please refer to the documentation in the doc/
11subdirectory for complete documentation.
12
13--------------------------
14Quick install
15--------------------------
16
17If you are setting the user configuration file with --with-usermakeconf
18and/or --with-usergmakeconf you'll probably need to enclose the argumen
19with single quotes to prevent shell expansion during configuration.  For
20example,
21
22  --with-usermakeconf=${HOME}/.latex-mk.conf
23
24will end up hardcoding the home directory of the particular user who
25ran the configuration script.  If you are setting this up for multiple
26users, you probably wanted to use
27
28  --with-usermakeconf='${HOME}/.latex-mk.conf'
29
30instead.
31
32--------------------------
33Acknowledgements
34--------------------------
35
36Thanks to Jeff Gealow who provided an example of a makefile for a
37LaTeX document many many years ago.  Thats where this all started.
38
39Thanks to Paul Smith and Darrin Jewell for help with GNU make.
40
41Thanks to Todd Sepke for the suggestions that led to the latex-mk
42script.
43
44Thanks to Jeff McMahill for suggesting that I add support for
45multiple top level documents with some common dependencies and
46some unique dependencies.
47
48Thanks to Karthikesh Raju for suggesting including a 'dist' target
49and for suggesting that the -draft output be supported.
50
51Thanks to Brook Milligan for suggesting that I add HTML output,
52POST_BIBTEX_HOOK, and providing general encouragement.  Brook also
53suggested the sweave support.
54
55Thanks to Antoine Reilles for suggesting that I add makeindex
56support and for providing a preliminary patch.
57
58Thanks to Reuben Thomas for suggesting that the latex-mk script
59be documented a bit more for standalone use and for suggesting
60a way to have the latex-mk script work with a read only source
61directory.
62
63Thanks to Rafael Laboissiere for suggesting that the testsuite
64run all shell scripts through 'sh -n' for a syntax check and for
65helping to track down some testsuite failures.  Rafael has also
66provided several small patches found as the Debian package
67maintainer.
68
69--------------------------
70Bugs
71--------------------------
72
73Please report all bugs on the latex-mk homepage at
74http://latex-mk.sourceforge.net
75
76