Skip to content

Commit

Permalink
readme, license, task
Browse files Browse the repository at this point in the history
  • Loading branch information
orsinium committed May 27, 2024
1 parent 53a3ebb commit 1d661b0
Show file tree
Hide file tree
Showing 3 changed files with 64 additions and 0 deletions.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -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.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.
20 changes: 20 additions & 0 deletions Taskfile.yml
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 1d661b0

Please sign in to comment.