re-organized readme structure

This commit is contained in:
Raffaele Mignone 2020-02-23 19:09:30 +01:00
parent d6a00fd74e
commit 4faf6f641b
Signed by: norangebit
GPG Key ID: F5255658CB220573

View File

@ -5,13 +5,13 @@ A pandoc LaTeX template for creating a curriculum vitae.
- [English](#english) - [English](#english)
- [Installation](#installation) - [Installation](#installation)
- [Usage](#usage) - [Usage](#usage)
- [Variables](#variables)
- [Docker](#docker) - [Docker](#docker)
- [Variables](#variables)
- [Italiano](#italiano) - [Italiano](#italiano)
- [Installazione](#installazione) - [Installazione](#installazione)
- [Uso](#uso) - [Uso](#uso)
- [Variabili](#variabili)
- [Docker](#docker-1) - [Docker](#docker-1)
- [Variabili](#variabili)
## English ## English
@ -40,6 +40,29 @@ In the following example all variables have been set within the `cv.yaml` file a
pandoc cv.yaml --template pancv -o cv.pdf pandoc cv.yaml --template pancv -o cv.pdf
``` ```
### Docker
This template can also be used through a [docker](https://www.docker.com/) container.
The first operation to do is to retrieve the [`norangebit/pandocker`](https://git.norangeb.it/norangebit/pandocker) image through the following command:
```bash
docker pull norangebit/pandocker
```
after which you can run the container with the command:
```bash
docker run --rm --volume "`pwd`:/data" --user `id -u`:`id -g` norangebit/pandocker <cmd>
```
where instead of `<cmd>` the desired pandoc command must be inserted.
For example, you can get the same result as the [previous example](#usage) through the command:
```
docker run --rm --volume "`pwd`:/data" --user `id -u`:`id -g` norangebit/pandocker pandoc cv.yaml --template pancv -o cv.pdf
```
### Variables ### Variables
- `europass` (*boolean*) equal to `true` if you want a curriculum in *europass* format - `europass` (*boolean*) equal to `true` if you want a curriculum in *europass* format
@ -67,29 +90,6 @@ pandoc cv.yaml --template pancv -o cv.pdf
- `left` (*string*) left part of the section. - `left` (*string*) left part of the section.
- `right` (*string*) right part of the section. - `right` (*string*) right part of the section.
### Docker
This template can also be used through a [docker](https://www.docker.com/) container.
The first operation to do is to retrieve the [`norangebit/pandocker`](https://git.norangeb.it/norangebit/pandocker) image through the following command:
```bash
docker pull norangebit/pandocker
```
after which you can run the container with the command:
```bash
docker run --rm --volume "`pwd`:/data" --user `id -u`:`id -g` norangebit/pandocker <cmd>
```
where instead of `<cmd>` the desired pandoc command must be inserted.
For example, you can get the same result as the [previous example](#usage) through the command:
```
docker run --rm --volume "`pwd`:/data" --user `id -u`:`id -g` norangebit/pandocker pandoc cv.yaml --template pancv -o cv.pdf
```
## Italiano ## Italiano
**Pancv** è un template per [pandoc](https://pandoc.org/) per la realizzazione di *curriculum vitae*. **Pancv** è un template per [pandoc](https://pandoc.org/) per la realizzazione di *curriculum vitae*.
@ -117,6 +117,29 @@ Nel seguente esempio tutte le variabili sono state settate all'interno del file
pandoc cv.yaml --template pancv -o cv.pdf pandoc cv.yaml --template pancv -o cv.pdf
``` ```
### Docker
Questo template può essere utilizzato anche a traverso un container [docker](https://www.docker.com/).
La prima operazione da fare è recuperare l'immagine [`norangebit/pandocker`](https://git.norangeb.it/norangebit/pandocker) attraverso il seguente comando:
```bash
docker pull norangebit/pandocker
```
dopo di che è possibile eseguire il container con il comando:
```bash
docker run --rm --volume "`pwd`:/data" --user `id -u`:`id -g` norangebit/pandocker <cmd>
```
dove al posto di `<cmd>` va inserito il comando pandoc desiderato.
Per esempio si può ottenere lo stesso risultato dell'[esempio precedente](#uso) attraverso il comando:
```
docker run --rm --volume "`pwd`:/data" --user `id -u`:`id -g` norangebit/pandocker pandoc cv.yaml --template pancv -o cv.pdf
```
### Variabili ### Variabili
- `europass` (*boolean*) pari a `true` se si desidera un curriculum in formato *europass* - `europass` (*boolean*) pari a `true` se si desidera un curriculum in formato *europass*
@ -143,27 +166,3 @@ pandoc cv.yaml --template pancv -o cv.pdf
- `items` (*list*) elementi della sezione. - `items` (*list*) elementi della sezione.
- `left` (*string*) parte di sinistra della sezione. - `left` (*string*) parte di sinistra della sezione.
- `right` (*string*) parte di destra della sezione. - `right` (*string*) parte di destra della sezione.
### Docker
Questo template può essere utilizzato anche a traverso un container [docker](https://www.docker.com/).
La prima operazione da fare è recuperare l'immagine [`norangebit/pandocker`](https://git.norangeb.it/norangebit/pandocker) attraverso il seguente comando:
```bash
docker pull norangebit/pandocker
```
dopo di che è possibile eseguire il container con il comando:
```bash
docker run --rm --volume "`pwd`:/data" --user `id -u`:`id -g` norangebit/pandocker <cmd>
```
dove al posto di `<cmd>` va inserito il comando pandoc desiderato.
Per esempio si può ottenere lo stesso risultato dell'[esempio precedente](#uso) attraverso il comando:
```
docker run --rm --volume "`pwd`:/data" --user `id -u`:`id -g` norangebit/pandocker pandoc cv.yaml --template pancv -o cv.pdf
```