diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..b9b9887 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + + 2024 Firefly Zero + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included +in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..8d97eee --- /dev/null +++ b/README.md @@ -0,0 +1,23 @@ +# Snek + +Snake-inspired game with 360° movement. Written in Go for [Firefly Zero](https://fireflyzero.com/) using [the official SDK](https://github.com/firefly-zero/firefly-go). + +## Installation + +Install from the [catalog](https://catalog.fireflyzero.com/) using [firefly-cli](https://github.com/firefly-zero/firefly-cli): + +```bash +firefly_cli import firefly.snek +``` + +Build and install from source: + +```bash +git clone https://github.com/firefly-zero/snek.git +cd snek +firefly_cli build +``` + +## License + +[MIT License](./LICENSE). Feel free to reuse pieces of this game as you see fit. diff --git a/Taskfile.yml b/Taskfile.yml new file mode 100644 index 0000000..04ef432 --- /dev/null +++ b/Taskfile.yml @@ -0,0 +1,20 @@ +# https://taskfile.dev +version: '3' + +tasks: + build: + desc: build ROM + cmds: + - firefly_cli build + - firefly_cli export + release: + desc: build and publish release + cmds: + - task: build + - test {{.CLI_ARGS}} + - git tag {{.CLI_ARGS}} + - git push + - git push --tags + - gh release create --generate-notes {{.CLI_ARGS}} + - gh release upload {{.CLI_ARGS}} firefly.snek.zip +