You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

README.md 2.5KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192
  1. Hi,
  2. Welcome to the beginnings of Tufte LaTeX package to help you
  3. produce Tufte-style handouts, reports, and notes.
  4. ## Quick Start
  5. Try typesetting `sample-handout.tex` with the following sequence
  6. of commands,
  7. pdflatex sample-handout
  8. bibtex sample-handout
  9. pdflatex sample-handout
  10. pdflatex sample-handout
  11. The result should look like `sample-handout.pdf`.
  12. The sample book can be compiled with the following:
  13. pdflatex sample-book
  14. bibtex sample-book
  15. texindy --language english sample-book.idx
  16. # or makeindex sample-book.idx
  17. pdflatex sample-book
  18. pdflatex sample-book
  19. pdflatex sample-book
  20. ## Troubleshooting
  21. If you encounter errors of the form,
  22. ! LaTeX Error: File `paralist.sty' not found.
  23. you will need to obtain missing packages from [CTAN](http://ctan.org).
  24. For package installation instructions and answers to many other
  25. questions, see the [UK TeX FAQ](http://www.tex.ac.uk/cgi-bin/texfaq2html?introduction=yes) or search the [`comp.text.tex` group](http://groups.google.com/group/comp.text.tex).
  26. The following packages are required:
  27. * chngpage or changepage
  28. * fancyhdr
  29. * fontenc
  30. * geometry
  31. * hyperref
  32. * natbib and bibentry
  33. * optparams
  34. * paralist
  35. * placeins
  36. * ragged2e
  37. * setspace
  38. * textcase
  39. * textcomp
  40. * titlesec
  41. * titletoc
  42. * xcolor
  43. * xifthen
  44. The following packages are optional and will be automatically used if installed:
  45. * beramono
  46. * helvet
  47. * ifpdf
  48. * ifxetex
  49. * letterspace (in the microtype package)
  50. * mathpazo
  51. * soul
  52. ## Bugs/Features/Support
  53. For kudos, feature requests, patches, or support requests that you
  54. feel are _particular_ to this Tufte-LaTeX package, i.e., not a general
  55. LaTeX issue, please use this project's issue tracker available at <https://github.com/Tufte-LaTeX/tufte-latex/issues>.
  56. ## Contributing
  57. Patches and pull requests are most welcome via the issue tracker! Submit a series of high quality patches, and you'll find yourself a developer on this project.
  58. ## License
  59. Copyright 2007–2015 by Kevin Godby, Bil Kleb, and Bill Wood.
  60. Licensed under the Apache License, Version 2.0 (the "License");
  61. you may not use this file except in compliance with the License.
  62. You may obtain a copy of the License at
  63. http://www.apache.org/licenses/LICENSE-2.0
  64. Unless required by applicable law or agreed to in writing, software
  65. distributed under the License is distributed on an "AS IS" BASIS,
  66. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  67. See the License for the specific language governing permissions and
  68. limitations under the License.