diff --git a/README b/README deleted file mode 100644 index 25fb9f4d118d431527aaed7c96d03fdee0283b20..0000000000000000000000000000000000000000 --- a/README +++ /dev/null @@ -1,23 +0,0 @@ -## Installation ## -# -The following packages should be installed: - texlive-base-bin texlive-latex-base texlive-latex-recommended - texlive-latex-extra texlive-fonts-recommended texlive-science latex-beamer - ghostscript - -## Making a new presentation ## -# -To make a new presentation, run the mkpres command: ---- -sh mkpres.sh <directory> ---- - -## Compiling ## -# -Edit presentation.tex.. - -To make a postscript file, type `make'. -For a pdf, type `make release' (this will also throw away all temporary files). -To clean everything except the ps and pdf files, type `make clean'. -To clean everything, type `make distclean' (of course the source will not be - thrown away). diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..d0234ad4ccbbb1e72949bdcd096cdb881669f7df --- /dev/null +++ b/README.md @@ -0,0 +1,46 @@ +# LaTeX presentation template +This repository provides a LaTeX template for LUMC styled presentations. + +## Installation +Install all dependencies: + + apt-get install texlive-base-bin texlive-latex-base \ + texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended \ + texlive-science latex-beamer ghostscript + +## Making a new presentation +Add this repository as a submodule of your project: + + git submodule add https://git.lumc.nl/j.f.j.laros/presentation.git + +You also might want to use the central pictures repository: + + git submodule add https://git.lumc.nl/humgen/presentation-pics.git + +Make a new presentation using the following command: + + cd presentation + bash mkpres.sh ../mypresentation + +## Usage +The presentation is compiled with a Makefile. + + make + +To clean everything, except for output files and important temporary files +(bibliography, glossary, encapsulated postscript files): + + make clean + +To clean everything including temporary files: + + make distclean + +### Pictures +Using pictures is relatively straightforward. Every file in the current +directory with file extension **dot**, **gif**, **jpg**, **png**, **ppm**, +**svg**, **xcf**, or **dia** will be automatically converted into encapsulated +postscript. + +Gnuplot files (with extension **gnp**) are converted to encapsulated postscript +as well.