Skip to content

Commit 257dfbe

Browse files
committed
Add docs
1 parent f518c0b commit 257dfbe

File tree

1 file changed

+36
-1
lines changed

1 file changed

+36
-1
lines changed

README.md

Lines changed: 36 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,37 @@
11
# install-opendylan
2-
GitHub Action to install Open Dylan
2+
3+
A GitHub Action to install the Open Dylan compiler.
4+
5+
Example:
6+
7+
```yaml
8+
- uses: dylan-lang/install-opendylan@v1
9+
with:
10+
version: 2020.1
11+
```
12+
13+
The version is optional and will generally default to the latest release.
14+
15+
Complete job example using the `strings` library:
16+
17+
```yaml
18+
jobs:
19+
build-and-test:
20+
runs-on: ubuntu-latest
21+
steps:
22+
- uses: dylan-lang/install-opendylan@v1
23+
24+
- name: Build strings-test-suite
25+
run: ./dylan-compiler -build -jobs 3 strings-test-suite
26+
27+
- name: Run strings-test-suite
28+
run: _build/bin/strings-test-suite
29+
```
30+
31+
When this Action has completed two artifacts exist at the top-level in your
32+
GitHub workspace:
33+
34+
1. A symbolic link named `opendylan` that points to the Open Dylan
35+
installation directory.
36+
37+
2. A link to the `dylan-compiler` binary.

0 commit comments

Comments
 (0)