Skip to content

Commit

Permalink
refactor: readme
Browse files Browse the repository at this point in the history
  • Loading branch information
deemp committed Jan 13, 2024
1 parent 613b7f4 commit 4addead
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,17 +80,33 @@ Otherwise, the triggered CI jobs will fail.

#### Set up pre-commit

##### Single command

```console
pip3 install
pre-commit install
stack install fourmolu
chmod +x scripts/run-fourmolu.sh
```

##### Step by step

1. Install [Python 3](https://www.python.org/downloads/) (e.g., Python 3.10).
1. [Install pre-commit](https://pre-commit.com/#1-install-pre-commit).
- Alternatively, run `pip3 install`.
1. [Install the git hook scripts](https://pre-commit.com/#3-install-the-git-hook-scripts).
1. Install [fourmolu](https://github.com/fourmolu/fourmolu)
1. Install [fourmolu](https://github.com/fourmolu/fourmolu).

```console
stack install fourmolu
```

- You can remove `fourmolu` later (see [SO post](https://stackoverflow.com/a/38639959))
1. Make a script executable.

```console
chmod +x scripts/run-fourmolu.sh
```

#### pre-commit configs

Expand Down

0 comments on commit 4addead

Please sign in to comment.