sokoban
Diffstat (limited to 'README.md')
-rw-r--r--README.md37
1 files changed, 37 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7575a7e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,37 @@
+# godot-template
+
+Godot template repository for my programs
+
+---
+
+# How to use
+
+- To use: click use this template button.
+- Clone your repository
+- Add your files
+- Commit
+- Push
+
+<details>
+<summary>For itch.io depoloyment</summary>
+<br>
+Add a secret called BUTLER_CREDENTIALS with your butler api key.
+</details>
+
+<details>
+<summary>For android builds</summary>
+<br>
+Add two secrets:
+ ANDROID_KEYSTORE_BASE64
+ ANDROID_KEYSTORE_PASSWORD
+</details>
+
+---
+
+### Availability:
+
+| windows | ios | linux | android | mac | html | |
+|:------------------:|:---:|:------------------:|:------------------:|:------------------:|:------------------:|:-------------:|
+| :x: | :x: | :x: | :x: | :x: | :heavy_check_mark: | github pages |
+| :heavy_check_mark: | :x: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | itch.io |
+| :heavy_check_mark: | :x: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | godot exports |