Add basic ReadMe.md
This commit is contained in:
parent
467a88a5d9
commit
27a2f39095
1 changed files with 26 additions and 0 deletions
26
ReadMe.md
Normal file
26
ReadMe.md
Normal file
|
@ -0,0 +1,26 @@
|
|||
# Build Godot
|
||||
|
||||
This action builds the godot project in your `$GITHUB_WORKSPACE`, so that you can easily automate builds.
|
||||
|
||||
## Usage
|
||||
|
||||
Example:
|
||||
|
||||
```yaml
|
||||
steps:
|
||||
- uses: josephbmanley/build-godot-action@develop
|
||||
env:
|
||||
PROJECT: godot-project
|
||||
```
|
||||
|
||||
### Environment Variables
|
||||
|
||||
- #### PROJECT **REQUIRED**
|
||||
|
||||
Name of the project files to output.
|
||||
|
||||
Eg. `godot-project` will export to `godot-project.exe`
|
||||
|
||||
## Credits
|
||||
|
||||
This action uses the [godot-ci](https://github.com/aBARICHELLO/godot-ci) docker image from [BARICHELLO](https://github.com/aBARICHELLO)
|
Reference in a new issue