summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/tufte-latex/README.txt
blob: 57b8ba4fa32ad5394538cfb0c63df1eeb8266081 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
Hi,

Welcome to the beginnings of Tufte LaTeX package to help you
produce Tufte-style handouts, reports, and notes.

== Quick Start

Try typesetting sample-handout.tex with the following sequence
of commands,

 pdflatex sample-handout
 bibtex   sample-handout
 pdflatex sample-handout
 pdflatex sample-handout

The result should look like sample-handout.pdf.

The sample book can be compiled with the following:

 pdflatex sample-book
 bibtex sample-book
 texindy --language english sample-book.idx
 # or makeindex sample-book.idx
 pdflatex sample-book
 pdflatex sample-book
 pdflatex sample-book

== Troubleshooting

If you encounter errors of the form,

 ! LaTeX Error: File `paralist.sty' not found.

you will need to obtain missing packages from CTAN <http://ctan.org>.
For package installation instructions and answers to many other
questions, see the UK TeX FAQ,

 http://www.tex.ac.uk/cgi-bin/texfaq2html?introduction=yes

or search the news:comp.text.tex group via,

 http://groups.google.com/group/comp.text.tex

The following packages are required:

 * chngpage or changepage
 * fancyhdr
 * fontenc
 * geometry
 * hyperref
 * natbib and bibentry
 * optparams
 * paralist
 * placeins
 * ragged2e
 * setspace
 * textcase
 * textcomp
 * titlesec
 * titletoc
 * xcolor
 * xifthen

The following packages are optional and will be automatically used if installed:

 * beramono
 * helvet
 * ifpdf
 * ifxetex
 * letterspace (in the microtype package)
 * mathpazo
 * soul

== Bugs/Features/Support

For kudos, feature requests, patches, or support requests that you
feel are /particular/ to this Tufte-LaTeX package, i.e., not a general
LaTeX issue, please use this project's issue tracker available at

 http://tufte-latex.googlecode.com

== Contributing

Patches are most welcome via the issue tracker!  Submit a series of
high quality patches, and you'll find yourself a developer on this project.

== License

Copyright 2007-2010 by Kevin Godby, Bil Kleb, and Bill Wood.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.