Skip to content

Commit

Permalink
Add example for CLI switches
Browse files Browse the repository at this point in the history
Add switches to get three reruns after the first and to print the TeX engine's chatter during processing. With conformity to Markdown style guidelines.
  • Loading branch information
mavaddat authored Jul 15, 2020
1 parent a0c3f92 commit 82d6de8
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ Pushes a Compiled PDF file parallel to the tex, xtx file, if push is passed as '
## Example usage

### Pushes Compiled PDF

```
on: [push]
Expand All @@ -67,6 +68,28 @@ jobs:
```

### Doesn't Push Compiled PDF

```
on: [push]
jobs:
latex-job:
runs-on: ubuntu-latest
name: A job to Compile Latex file
steps:
- uses: actions/checkout@v1
- name: Compilation
uses: vinay0410/tectonic-action@master
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
tex_path: 'dir/file.tex'
```

### CLI Switches

Suppose we want three reruns after the first and to print the TeX engine's chatter during processing. We adapt `Pushes Compiled PDF` example to our purpose as follows:

```
on: [push]
Expand All @@ -82,4 +105,6 @@ jobs:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
tex_path: 'dir/file.tex'
push: 'yes'
swtiches: --reruns 3 --print
```

0 comments on commit 82d6de8

Please sign in to comment.