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

Add details to readme #2

Merged
merged 1 commit into from
Mar 3, 2023
Merged

Add details to readme #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 14 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,32 @@
# setup-roc

A GitHub Action to install Roc.
Currently, only installs the latest nightly version.

## Usage

Add the following step to a GitHub actions workflow file to install Roc.
Add a step that uses `hasnep/setup-roc` to a GitHub actions workflow file to install Roc and add the binary to the `PATH`.

```yaml
steps:
- name: Install Roc
uses: hasnep/setup-roc@main
with:
roc-version: nightly
- name: Check the Roc version
run: roc --version
```

The action is designed to work on

- Linux
- x86-64
- MacOS
- Apple Silicon (ARM64)
- x86-64

Other combinations of platform and processor are not currently supported.

### Inputs

- `roc-version` - The version of Roc to use, defaults to `nightly`.
Expand Down