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.

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

add parameters with examples to README.md #4

Merged
merged 1 commit into from
Feb 3, 2024
Merged
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
35 changes: 34 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ GitHub action to lint project on **RenPy**
## Menu

- [Quickstart](#quickstart)
- [Parameters](#parameters)
- [Mission](#mission)
- [Open Source Project](#open-source-project)
- [Features](#features)
Expand Down Expand Up @@ -68,7 +69,7 @@ jobs:
with:
version: "8.1.3"
- name: Lint RenPy
uses: PaxlavaGames/renpy-lint@v0.1.0
uses: PaxlavaGames/renpy-lint@v0.2.0
```

### Run using last version (maybe unstable)
Expand All @@ -78,6 +79,38 @@ uses: PaxlavaGames/renpy-install@main
uses: PaxlavaGames/renpy-lint@main
```

## Parameters

### Optional parameters

- `path` - path to `renpy` project folder (In this folder there is `game` folder). Default value = `"."` (current directory) For example in this repository it's `.testing`

### Example usage with parameters

```yaml
name: Lint RenPy

on:
push:

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Install RenPy
uses: PaxlavaGames/renpy-install@v0.1.2
with:
version: "8.1.3"
- name: Check SDK
run: |
ls
- name: Lint RenPy
uses: PaxlavaGames/renpy-lint@0.2.0
with:
path: "./testing"
```

## Mission

To create useful and user-friendly GitHub action for **RenPy** projects
Expand Down
Loading