Skip to content

Commit 74927af

Browse files
authored
Merge pull request #10 from MaxUlysse/1.7.1
enhance README
2 parents eb8f70c + d79aa55 commit 74927af

File tree

1 file changed

+23
-11
lines changed

1 file changed

+23
-11
lines changed

README.md

Lines changed: 23 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,32 @@
11
# compile-beamer
22

3-
[![Version][version-badge]][version-link] [![License][license-badge]][license-link] [![Nextflow version][nextflow-badge]][nextflow-link] [![CircleCI status][circleci-badge]][circleci-link] [![Travis status][travis-badge]][travis-link] [![works on my machine][works-badge]][works-link]
3+
[![Version][version-badge]][version-link]
4+
[![License][license-badge]][license-link]
5+
[![Nextflow version][nextflow-badge]][nextflow-link]
6+
[![Travis status][travis-badge]][travis-link]
7+
[![CircleCI status][circleci-badge]][circleci-link]
8+
[![works on my machine][works-badge]][works-link]
49

5-
Beamer compiler in Nextflow using XeLaTex.
6-
7-
Beamer presentations can be easily compiled. A Docker container is provided. It's a `debian:stretch-slim` image containing `texlive-xetex`, `mtheme`, `python-pygments` (for `minted`) and `Fira fonts`. A Singularity container based on the Docker container is also available.
10+
[Beamer][beamer-link] compiler in [Nextflow][nextflow-link-link] using [XeLaTex][xetex-link].
811

912
## Options
1013

1114
### --tex
12-
Compile the given tex file
15+
Compile the given tex file.
1316

1417
### --pictures
15-
Specify in which directory are the pictures
16-
Default is: `pictures/`
18+
Specify in which directory are the pictures.
19+
Default is: `pictures/`.
1720

1821
### --tag
19-
Specify with tag to use for the docker container
20-
Default is current version
22+
Specify with tag to use for the docker container.
23+
Default is current version.
2124

2225
### --help
23-
You're reading it
26+
You're reading it.
2427

2528
### --version
26-
Displays version number
29+
Displays version number.
2730

2831
## Usage with Docker [![Docker status][docker-badge]][docker-link]
2932

@@ -33,6 +36,10 @@ nextflow run MaxUlysse/compile-beamer /
3336
--tex <file.tex>
3437
```
3538

39+
## Docker container
40+
Based on `debian:stretch-slim`.
41+
Contain: `texlive-xetex`, `mtheme`, `python-pygments` (for `minted`) and `Fira fonts`.
42+
3643
## Usage with Singularity [![Singularity status][singularity-badge]][singularity-link]
3744

3845
```bash
@@ -41,6 +48,10 @@ nextflow run MaxUlysse/compile-beamer /
4148
--tex <file.tex>
4249
```
4350

51+
## Singularity container
52+
Based on the Docker container
53+
54+
[beamer-link]: https://github.com/josephwright/beamer
4455
[circleci-badge]: https://circleci.com/gh/MaxUlysse/compile-beamer.svg?style=shield
4556
[circleci-link]: https://circleci.com/gh/MaxUlysse/compile-beamer
4657
[docker-badge]: https://img.shields.io/docker/automated/maxulysse/compile-beamer.svg
@@ -57,3 +68,4 @@ nextflow run MaxUlysse/compile-beamer /
5768
[version-link]: https://github.com/MaxUlysse/compile-beamer/releases/releases/latest
5869
[works-badge]: https://img.shields.io/badge/works-on_my_machine-brightgreen.svg
5970
[works-link]: https://github.com/nikku/works-on-my-machine
71+
[xetex-link]: http://xetex.sourceforge.net/

0 commit comments

Comments
 (0)