Skip to content

Commit

Permalink
Add preconditions to README
Browse files Browse the repository at this point in the history
Signed-off-by: Tobias Brumhard <tobias.brumhard@mail.schwarz>
  • Loading branch information
brumhard committed Oct 30, 2021
1 parent b5379d5 commit 731c951
Showing 1 changed file with 16 additions and 4 deletions.
20 changes: 16 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,17 +24,29 @@

## Usage

### Install
### Installation

#### From source

If you have Go 1.16+, you can directly install by running:

```bash
go install github.com/schwarzit/go-template/cmd/gt@latest
```

#### Install from the released binaries
Download the desired version for your operating system and processor architecture from the [go-template releases page](https://github.com/SchwarzIT/go-template/releases).
Make the file executable and place it in a directory available in your $PATH.
#### From the released binaries

Download the desired version for your operating system and processor architecture from the [go-template releases page](https://github.com/SchwarzIT/go-template/releases).
Make the file executable and place it in a directory available in your `$PATH`.

### Preconditions

`go/template`'s `gt` CLI requires at least the following executables on `$PATH` to run succesfully:

- Go >= 1.15
- Git

These are used at the end of `gt new`'s execution to initialize Git and Go modules in the newly created project repository.

### Initialize your repo from the template

Expand Down

0 comments on commit 731c951

Please sign in to comment.