diff --git a/README.md b/README.md index b46e043fe8fa02e84918b95c0500f9db7534aaec..7616b6a32473e26663021555132f705880061f70 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,23 @@ -# latex-proposal-template +# ISG LaTeX proposal template +Getting started +--------------- + +1. Install an up-to-date LaTeX distribution (e.g. [TeX Live](https://www.tug.org/texlive/)) +2. Clone the repository `git clone https://git.cs.upb.de/ag-intelligentsystems/templates/latex-proposal-template.git` +3. Build the document using `latexmk` or another build tool of your choice: +```latexmk -pdf paper.tex``` +4. The finished document will be called `paper.pdf` + +Best practices +------------------ + +### References +The proposal template uses the LaTeX package [BibLaTeX](https://www.ctan.org/pkg/biblatex?lang=de). + +A well curated source of BibTeX entries is the [dblp](http://dblp.uni-trier.de/). Search for your references here, export the record and download the file as `.bib` file. The contents you can paste into your `literature.bib` file. + +#### Useful BibLaTeX command: +* `\cite{doe2015}`: Inserts the name(s) of the author(s) at the current position and +follows it with the reference. +* For more commands check out the detailed [BibLaTeX documentation](https://ftp.uni-erlangen.de/ctan/macros/latex/contrib/biblatex/doc/biblatex.pdf)