Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
30 changes: 29 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,30 @@
# setup-supercollider
Setup your GitHub Actions workflow with SuperCollider from source

Setup your GitHub Actions workflow with headless SuperCollider built from
source.

Validated to work on GitHub's standard `macos-15`, `ubuntu-latest`, and
`windows-latest` runners.

## Inputs

| Title | Required | Type | Default | Description |
|---------|----------|--------|------------------------------------------------------|------------------------------|
| origin | False | string | `https://github.com/supercollider/supercollider.git` | SuperCollider repository URL |
| ref | False | string | `develop` | SuperCollider branch/tag ref |

## Outputs

| Title | Type | Description |
|----------------|--------|------------------------------|
| sclang_path | string | path to `sclang` binary |
| scsynth_path | string | path to `scsynth` binary |
| supernova_path | string | path to `supernova` binary |

## Caching

Windows workflows will automatically cache `vcpkg` archives.

We strongly recommend you also use https://github.com/hendrikmuhs/ccache-action
to prior to running this action in order to cache `ccache` for additional
speedups.
2 changes: 1 addition & 1 deletion action.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ inputs:
required: false
default: https://github.com/supercollider/supercollider.git
ref:
description: SuperCollider ref
description: SuperCollider branch/tag ref
required: false
default: develop
outputs:
Expand Down
Loading