diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..6c1e18e --- /dev/null +++ b/.gitignore @@ -0,0 +1,136 @@ +## Core latex/pdflatex auxiliary files: +*.aux +*.lof +*.log +*.lot +*.fls +*.out +*.toc + +## Intermediate documents: +*.dvi +*-converted-to.* +# these rules might exclude image files for figures etc. +# *.ps +# *.eps +# *.pdf + +## Bibliography auxiliary files (bibtex/biblatex/biber): +*.bbl +*.bcf +*.blg +*-blx.aux +*-blx.bib +*.brf +*.run.xml + +## Build tool auxiliary files: +*.fdb_latexmk +*.synctex +*.synctex.gz +*.synctex.gz(busy) +*.pdfsync + +## Auxiliary and intermediate files from other packages: + +# algorithms +*.alg +*.loa + +# achemso +acs-*.bib + +# amsthm +*.thm + +# beamer +*.nav +*.snm +*.vrb + +#(e)ledmac/(e)ledpar +*.end +*.[1-9] +*.[1-9][0-9] +*.[1-9][0-9][0-9] +*.[1-9]R +*.[1-9][0-9]R +*.[1-9][0-9][0-9]R +*.eledsec[1-9] +*.eledsec[1-9]R +*.eledsec[1-9][0-9] +*.eledsec[1-9][0-9]R +*.eledsec[1-9][0-9][0-9] +*.eledsec[1-9][0-9][0-9]R + +# glossaries +*.acn +*.acr +*.glg +*.glo +*.gls + +# gnuplottex +*-gnuplottex-* + +# hyperref +*.brf + +# knitr +*-concordance.tex +*.tikz +*-tikzDictionary + +# listings +*.lol + +# makeidx +*.idx +*.ilg +*.ind +*.ist + +# minitoc +*.maf +*.mtc +*.mtc0 + +# minted +_minted* +*.pyg + +# morewrites +*.mw + +# nomencl +*.nlo + +# sagetex +*.sagetex.sage +*.sagetex.py +*.sagetex.scmd + +# sympy +*.sout +*.sympy +sympy-plots-for-*.tex/ + +# todonotes +*.tdo + +# xindy +*.xdy + +# WinEdt +*.bak +*.sav + +# Vim +[._]*.s[a-w][a-z] +[._]s[a-w][a-z] +*.un~ +Session.vim +.netrwhist +*~ + + diff --git a/README.txt b/README.md similarity index 54% rename from README.txt rename to README.md index 57b8ba4..1e368f6 100644 --- a/README.txt +++ b/README.md @@ -3,43 +3,37 @@ Hi, Welcome to the beginnings of Tufte LaTeX package to help you produce Tufte-style handouts, reports, and notes. -== Quick Start +## Quick Start -Try typesetting sample-handout.tex with the following sequence +Try typesetting `sample-handout.tex` with the following sequence of commands, - pdflatex sample-handout - bibtex sample-handout - pdflatex sample-handout - pdflatex sample-handout + pdflatex sample-handout + bibtex sample-handout + pdflatex sample-handout + pdflatex sample-handout -The result should look like sample-handout.pdf. +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 + 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 +## Troubleshooting If you encounter errors of the form, - ! LaTeX Error: File `paralist.sty' not found. + ! LaTeX Error: File `paralist.sty' not found. -you will need to obtain missing packages from CTAN . +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 +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). The following packages are required: @@ -71,22 +65,19 @@ The following packages are optional and will be automatically used if installed: * mathpazo * soul -== Bugs/Features/Support +## 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 +feel are _particular_ to this Tufte-LaTeX package, i.e., not a general +LaTeX issue, please use this project's issue tracker available at . -== Contributing +## 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. +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. -== License +## License -Copyright 2007-2010 by Kevin Godby, Bil Kleb, and Bill Wood. +Copyright 2007–2015 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. diff --git a/sample-book.pdf b/sample-book.pdf index dad02a7..c393461 100644 Binary files a/sample-book.pdf and b/sample-book.pdf differ diff --git a/sample-book.tex b/sample-book.tex index f364575..4a4b79b 100644 --- a/sample-book.tex +++ b/sample-book.tex @@ -194,7 +194,7 @@ Copyright \copyright\ \the\year\ \thanklessauthor \par\smallcaps{Published by \thanklesspublisher} -\par\smallcaps{tufte-latex.googlecode.com} +\par\smallcaps{tufte-latex.github.io/tufte-latex/} \par 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 @@ -1054,7 +1054,7 @@ The following headings are not supported: \doccmd{subsubsection} and \doccmd{sub \section{\TL Website}\label{sec:website} The website for the \TL packages is located at -\url{http://code.google.com/p/tufte-latex/}. On our website, you'll find +\url{https://github.com/Tufte-LaTeX/tufte-latex}. On our website, you'll find links to our \smallcaps{svn} repository, mailing lists, bug tracker, and documentation. \section{\TL Mailing Lists}\label{sec:mailing-lists} diff --git a/sample-handout.pdf b/sample-handout.pdf index 9676935..e0002a8 100644 Binary files a/sample-handout.pdf and b/sample-handout.pdf differ diff --git a/sample-handout.tex b/sample-handout.tex index 33528c7..a7e5faa 100644 --- a/sample-handout.tex +++ b/sample-handout.tex @@ -280,7 +280,7 @@ mentioned in this handout), please see the sample book. \section{Support}\label{sec:support} The website for the Tufte-\LaTeX\ packages is located at -\url{http://code.google.com/p/tufte-latex/}. On our website, you'll find +\url{https://github.com/Tufte-LaTeX/tufte-latex}. On our website, you'll find links to our \smallcaps{svn} repository, mailing lists, bug tracker, and documentation. \bibliography{sample-handout}