Skip to content

Commit

Permalink
Improve README
Browse files Browse the repository at this point in the history
  • Loading branch information
andyone committed Apr 25, 2024
1 parent 4db4cfb commit 7d056f3
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,20 +7,31 @@
<a href="#license"><img src="https://gh.kaos.st/apache2.svg"></a>
</p>

<p align="center"><a href="#usage-demo">Usage demo</a> • <a href="#installation">Installation</a> • <a href="#command-line-completion">Command-line completion</a> • <a href="#usage">Usage</a> • <a href="#contributing">Contributing</a> • <a href="#license">License</a></p>
<p align="center"><a href="#installation">Installation</a> • <a href="#command-line-completion">Command-line completion</a> • <a href="#usage">Usage</a> • <a href="#contributing">Contributing</a> • <a href="#license">License</a></p>

<br/>

`scratch` is a simple utility for generating blank files for Go apps, utilities and packages.

### Installation

> [!IMPORTANT]
> Before the first run you have to create a directory for your tempaltes. By default, all templates must be stored in the `~/.config/scratch` directory.

Check warning on line 19 in README.md

View workflow job for this annotation

GitHub Actions / Typos

"tempaltes" should be "templates".

Check warning on line 19 in README.md

View workflow job for this annotation

GitHub Actions / Typos

"tempaltes" should be "templates".
#### From sources

To install the `scratch` from sources, make sure you have a working Go 1.19+ workspace (_[instructions](https://go.dev/doc/install)_), then:

```
go install github.com/essentialkaos/scratch
go install github.com/essentialkaos/scratch@latest
```

#### Prebuilt binaries

You can download prebuilt binaries for Linux from [EK Apps Repository](https://apps.kaos.st/scratch/latest):

```bash
bash <(curl -fsSL https://apps.kaos.st/get) scratch
```

### Command-line completion
Expand Down

0 comments on commit 7d056f3

Please sign in to comment.