Skip to content
This repository has been archived by the owner on Jan 5, 2024. It is now read-only.

Commit

Permalink
hlint-setup/README: cosmetic changes
Browse files Browse the repository at this point in the history
  • Loading branch information
@andreasabel
andreasabel committed Dec 22, 2022
1 parent 761ba10 commit 66b3764
Showing 1 changed file with 7 additions and 9 deletions.
16 changes: 7 additions & 9 deletions hlint-setup/README.md
View file
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
# hlint-setup

GitHub Action: Set up hlint
GitHub Action: Set up `hlint`.

Downloads a binary of HLint from [@ndmitchell/hlint](https://github.com/ndmitchell/hlint).

The which gets cached through [@actions/tool-cache](https://github.com/actions/tool-cache)

And adds it into `PATH`.
Downloads a binary of HLint from [@ndmitchell/hlint](https://github.com/ndmitchell/hlint),
caches it through [@actions/tool-cache](https://github.com/actions/tool-cache),
and adds it into `PATH`.

See also [haskell/actions/hlint-run](https://github.com/haskell/actions/tree/main/hlint-run), which will run `hlint` and represent its output in GitHub annotations.

Expand All @@ -16,9 +14,9 @@ See also [haskell/actions/hlint-run](https://github.com/haskell/actions/tree/mai

## Outputs

* `hlint-dir`: Resulting directory containing the `hlint` executable
* `hlint-bin`: Location of the `hlint` executable
* `version`: Version of the `hlint` tool (same as input, if provided)
* `hlint-dir`: Resulting directory containing the `hlint` executable.
* `hlint-bin`: Location of the `hlint` executable.
* `version`: Version of the `hlint` tool (same as input, if provided).

## Example

Expand Down

0 comments on commit 66b3764

Please sign in to comment.