Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

361 provide instructions for the customer to check that weve completed the contract requirements #458

Merged
merged 2 commits into from
Aug 1, 2024
Merged

361 provide instructions for the customer to check that weve completed the contract requirements #458

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6fa6f15
refactor(site): improve installation instructions
deemp Jul 29, 2024
0810fa0
fix(site): update installation instructions
deemp Jul 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions site/docs/src/common/install-stack.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
See the official `stack` installation [documentation](https://docs.haskellstack.org/en/stable/install_and_upgrade/).
20 changes: 16 additions & 4 deletions site/docs/src/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,27 +1,39 @@
# Installation

## Environment requirements

- OS: `Ubuntu 22.04` or `macOS 12`.
- `stack` is installable.
- `normalizer` is installable.

## Install `stack`

{{#include ./common/install-stack.md}}

## Install `normalizer`

Install the `normalizer` executable globally via [stack](https://docs.haskellstack.org/en/stable).
Then, the `normalizer` executable will be available on `PATH`.

## Install from the repository
### Install `normalizer` from the repository

{{#include ./common/enter-repository.md}}

{{#include ./common/install.md}}

## Install from Hackage
### Install `normalizer` from Hackage

```sh
stack update
export LC_ALL=C.UTF-8
stack install --resolver lts-22.16 eo-phi-normalizer
```

## Update
## Update `normalizer`

Run `stack install ...` as in one of the methods above.

## Uninstall
## Uninstall `normalizer`

Learn where `stack` installs programs.

Expand Down
4 changes: 4 additions & 0 deletions site/docs/src/pipeline.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Pipeline

## Install `stack`

{{#include ./common/install-stack.md}}

## Enter the repository

{{ #include ./common/enter-repository.md }}
Expand Down