Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
boozook committed Jun 26, 2023
1 parent 6155b4c commit 585d288
Showing 1 changed file with 18 additions and 8 deletions.
26 changes: 18 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Get Playdate SDK

This GitHub Action delivers specified [Playdate] SDK.
<img src="//help.play.date/images/toolbar-icon-playdate.svg" alt="drawing" height="10em"/>
This GitHub Action delivers specified [Playdate SDK][Playdate].

[Playdate]: https://play.date/dev/#cardSDK

Expand All @@ -12,20 +13,29 @@ This GitHub Action delivers specified [Playdate] SDK.

## Usage Example

Download the latest version of dove
Install the latest version of Playdate SDK

```yaml
- name: Install Playdate SDK
id: playdate
uses: pd-rs/get-playdate-sdk@0.1.4
uses: pd-rs/get-playdate-sdk@0.1.6
with:
# possible values: version x.x.x or "latest"
version: latest
version: 2.0.0 # possible values: version `x.x.x` or `latest`

- name: usage
run: |
echo "SDK root: $PLAYDATE_SDK_PATH"
echo "SDK root: ${{ steps.playdate.outputs.root }}"
echo "SDK path env: $PLAYDATE_SDK_PATH"
echo "SDK root out: ${{ steps.playdate.outputs.root }}"
echo "SDK version: ${{ steps.playdate.outputs.version }}"
pdc --version
pdc --version # because SDK/bin already in PATH
```
## Supported platforms
- macOS
- Linux
- Windows
Note: for Windows there's [winget][] is used as source for specified SDK version, and as just installer-helper for `latest` version

[winget]: https://github.com/idleberg/winget-pkgs/tree/master/manifests/p/Panic/PlaydateSDK

0 comments on commit 585d288

Please sign in to comment.