summaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
author_Tradam <[email protected]>2022-05-18 03:07:23 -0400
committerGitHub <[email protected]>2022-05-18 03:07:23 -0400
commit105cfb6efb279c9c83d284ec1e11e22011e34a20 (patch)
tree9df386326798d1e1bbf7644dab0cc3cbaed328b2 /README.md
parent19df3e12cf66e8cd159cee75a4de42ceb4410a15 (diff)
downloadraylib-template-105cfb6efb279c9c83d284ec1e11e22011e34a20.tar.gz
raylib-template-105cfb6efb279c9c83d284ec1e11e22011e34a20.zip
Create README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d2ac796
--- /dev/null
+++ b/README.md
@@ -0,0 +1,13 @@
+# Github Actions Template For Raylib HTML5 Games
+This template allows you to automatically build your game and then upload it to itch.io when you push to master.
+
+### How modify for your use
+1. Create a copy of this template.
+2. Edit `.github/workflows/raylib-to-itch.yml`
+ - change your itch username and game name to your own
+3. Add your Itch API key to:
+ - Settings > Secrets > Actions > New Repository Secret
+ - Name it `BUTLER_API_KEY`
+4. Make sure to set a viewport for your game on Itch.io
+
+And that should be it, you game should automatically compile and uplaod to itch when you push to the master branch.