rudism
/
slangin
1
0
Fork 0
Code Issues Pull Requests Projects Releases 5 Wiki Activity

updated readme

This commit is contained in:
Rudis Muiznieks 2022-06-15 13:13:14 -05:00
parent 55085e4010
commit d0d2955e58
Signed by: rudism
GPG Key ID: CABF2F86EF7884F9
1 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -3,3 +3,20 @@
DrugWars (DopeWars) clone for the [Arduboy](https://www.arduboy.com). DrugWars (DopeWars) clone for the [Arduboy](https://www.arduboy.com).
[Reference implementation.](https://gist.github.com/mattmanning/1002653/b7a1e88479a10eaae3bd5298b8b2c86e16fb4404) [Reference implementation.](https://gist.github.com/mattmanning/1002653/b7a1e88479a10eaae3bd5298b8b2c86e16fb4404)
## Building
Run `make` to build `slangin.hex`. You need [arduino-cli](https://github.com/arduino/arduino-cli) on your path already set up to compile for the Arduboy.
## Running
Run `make run` to build and run the game. You need the [sim-arduboy](https://github.com/dxxb/sim-arduboy) emulator on your path.
To run on an actual device, use `arduino-cli` to upload `slangin.hex` after building. For example:
```
make && \
arduino-cli upload -b arduino:avr:leonardo -p /dev/ttyACM1 slangin.hex
```
Your port path (`-p` argument) may differ depending on your system.