Skip to content

Commit

Permalink
readme: usage
Browse files Browse the repository at this point in the history
  • Loading branch information
rumblefrog committed Nov 15, 2019
1 parent 2f49bf7 commit 60d8d11
Showing 1 changed file with 34 additions and 7 deletions.
41 changes: 34 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,42 @@
# Setup SourcePawn Action

Install and configure toolchain path for sourcepawn compiler
This action sets-up, cache and adds sourcemod scripting directory to the path

## Inputs
# Usage

### `version`
See [action.yml](https://github.com/rumblefrog/setup-sp/blob/master/action.yml)

**Required** The version (range) of compiler to use.
Basic:

## Outputs
```yaml
steps:
- uses: actions/checkout@v1

### `version`
- uses: actions/setup-sp@master
with:
version: '1.10.x'

The version used and added to path (useful if using a range specifier)
- run: spcomp -iAnotherIncludeDirectory plugin.sp -o output/plugin.smx
```
Matrix:
```yaml
jobs:
build:
runs-on: ubuntu-latest
strategy:
matrix:
sm-version: [ '1.10.x', '1.11.x', '1.11.6467']

name: SM version ${{ matrix.sm-version }}
steps:
- uses: actions/checkout@v1

- name: Setup SP
- uses: actions/setup-sp@master
with:
version: ${{ matrix.sm-version }}

- run: spcomp -iAnotherIncludeDirectory plugin.sp -o output/plugin.smx
```

0 comments on commit 60d8d11

Please sign in to comment.