Skip to content

Commit

Permalink
adds installation section in the README
Browse files Browse the repository at this point in the history
  • Loading branch information
kpym committed Aug 20, 2021
1 parent 0858a59 commit 3d348f8
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,32 @@ Examples:
> lol main.tex personal.sty images/img*.pdf
> cat main.tex | lol -c lualatex -o out.pdf
```

## Installation

### Precompiled executables

You can download the executable for your platform from the [Releases](https://github.com/kpym/lol/releases).

### Compile it yourself

#### Using Go

```
$ go get github.com/kpym/lol
```

#### Using goreleaser

After cloning this repo you can compile the sources with [goreleaser](https://github.com/goreleaser/goreleaser/) for all available platforms:

```
git clone https://github.com/kpym/lol.git .
goreleaser --snapshot --skip-publish --rm-dist
```

You will find the resulting binaries in the `dist/` sub-folder.

## Configuration

As `lol` use [viper](https://github.com/spf13/viper) the parameters can be provided not only by flags but also be read from config file (`lol.yaml`, `lol.toml`, `lol.json`...) or/and from environment variables (starting with `LOL_`).
Expand Down

0 comments on commit 3d348f8

Please sign in to comment.