summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMicha Rautenberg <mr@mrautenberg.de>2016-11-15 10:08:31 +0100
committerGitHub <noreply@github.com>2016-11-15 10:08:31 +0100
commitc15130af21232d0cd5f4e3f2d520ec5238c519c6 (patch)
treeef34731433a0e74d755dab1edc43a76904973ead /README.md
parentbb7b0826eb05d9875e9bbda7c12395526b45e5c4 (diff)
update README
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 11 insertions, 7 deletions
diff --git a/README.md b/README.md
index 1fee05d..02654fa 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,12 @@
# lazar-poster
-lazar-poster is a poster template that uses pandoc, pdflatex and beamer-poster to create scientific posters out of a \*.tex template and some markdown files. Markdown-files will be compiled to latex files by the makefile, before they are inserted into the beamerposter template. Markdown is much easier to edit for the textblocks and the *LaTeX* template provides a good possibility for positioning blocks and format posters.
+lazar-poster is a poster template that uses pandoc, pdflatex and beamer-poster to create scientific posters out of a \*.tex template and some markdown files. Markdown-files will be compiled to latex files by the makefile, before they are inserted into the beamerposter template. Markdown is much easier to edit for the textblocks and the *LaTeX* template provides a good possibility for positioning blocks and format posters. ```make```command generates PDF output in A0 Poster size, adjust the Makefile to compile your poster.
## Usage
### Edit header contents
Edit title, author, institute/company and footer
-```
+```latex
\title{lazar: a modular predictive toxicology framework}
\author{C. Helma, M. Rautenberg, D. Gebele}
\institute{\emph{in silico} toxicology gmbh, Basel, Switzerland}
@@ -14,7 +14,7 @@ Edit title, author, institute/company and footer
```
### Textblocks
Add a textblock with markdown-content (link the file company in directory markdown_blocks) for the company description.
-```
+```latex
\begin{textblock}{40.0}(1,6) % textblock, width 40, position x,y
\input{./markdown_blocks/company} % insert textblock company.tex
\end{textblock}
@@ -23,22 +23,26 @@ Add a textblock with markdown-content (link the file company in directory markdo
the directory *markdown_blocks* contains the markdown documents.
e.G.: company.md
-```
+```markdown
***my company***, Sometown, Everywhere – Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse commodo elit eget tellus posuere, eget blandit metus pretium. Mauris eu volutpat nisl. Praesent iaculis eros sit amet cursus fringilla. Morbi rhoncus bibendum odio, ut tincidunt sapien. Nam pellentesque nunc tellus, eu volutpat risus vehicula nec. Integer id volutpat mi.
```
### Citations
-add ```\cite{ArticleName}``` in the markdown document. Articles are listed in the file references.bib. References will be added automatically during compilation.
+to cite an article add
+```latex
+\cite{ArticleName}
+```
+in the markdown document. Articles are listed in the file references.bib. References will be added automatically during compilation.
### Add images
add images in the markdown files with standard markdown syntax
-```
+```markdown
![Endpoints](./images/my_image.png){width=600px }
```
### Add tables
see ```man pandoc``` for all table formats. This example is made with the *pipe_tables* extension.
-```
+```markdown
| Descriptor | Val1 | Val2 | Val3 |
|----------------|-----:|---------|:------:|
| Physchem A | 12 | 12 | 12 |