Skip to content

Commit

Permalink
update(readme): add usage
Browse files Browse the repository at this point in the history
  • Loading branch information
vinay0410 committed Oct 25, 2019
1 parent a2c3d05 commit ba272f5
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 14 deletions.
34 changes: 22 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,31 @@
# first-action
# Latex Action

This action prints "Hello World" or "Hello" + the name of a person to greet to the log.
This action compiles latex file using Tectonic, which automatically downloads required dependencies.
More Information about tectonic can be found [here](https://tectonic-typesetting.github.io/en-US/).

## Inputs

### `who-to-greet`
### `tex-path`

**Required** The name of the person to greet. Default `"World"`.
**Required** Path of tex, xtx file to compile.

## Outputs

### `time`

The time we greeted you.
Pushes a Compiled PDF file parallel to the tex, xtx file.

## Example usage

uses: actions/hello-world-docker-action@v1
with:
who-to-greet: 'Mona the Octocat'
```
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'
```
4 changes: 2 additions & 2 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@
name: 'Latex Compile'
description: 'Compile Latex Files'
inputs:
tex-path: # id of input
tex_path: # id of input
description: 'Path of Tex File'
required: true
runs:
using: 'docker'
image: 'Dockerfile'
args:
- ${{ inputs.tex-path }}
- ${{ inputs.tex_path }}

0 comments on commit ba272f5

Please sign in to comment.