From 9b6df7216fd3abc742c14b377fa4dcc5cb51ed83 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Juhani=20Krekel=C3=A4?= Date: Sat, 14 Jan 2023 22:59:35 +0200 Subject: [PATCH] Improve README.md --- README | 23 ----------------------- README.md | 33 +++++++++++++++++++++++++++++++++ 2 files changed, 33 insertions(+), 23 deletions(-) delete mode 100644 README create mode 100644 README.md diff --git a/README b/README deleted file mode 100644 index a9610d4..0000000 --- a/README +++ /dev/null @@ -1,23 +0,0 @@ -mato8 -===== -Mato8 is an implementation of the classic snake game for CHIP-8. You should -run mato8 at a speed of at least 900 IPS for the intended experience. - -Controls --------- -2 up -4 left -6 right -8 down - -NOTE: These are the CHIP-8 keys. Your implementation may map them to other -keys, e.g. 2 q e s. - -Building --------- -Mato8 is meant to be built with c8asm, which you can get from -https://github.com/wernsey/chip8 - -License -------- -Mato8 is released under CC0 1.0. diff --git a/README.md b/README.md new file mode 100644 index 0000000..cc2299d --- /dev/null +++ b/README.md @@ -0,0 +1,33 @@ +mato8 +===== +Mato8 is an implementation of the classic snake game for CHIP-8. You should +run mato8 at a speed of at least 900 IPS for the intended experience. + +Controls +-------- + 2 up + left 4 6 right + 8 down + +NOTE: These are the CHIP-8 keys. Your implementation may map them to other +keys, e.g. 2 q e s. + +Building +-------- +Mato8 is meant to be built with [c8asm](https://github.com/wernsey/chip8) + +Running +------- +Mato8 is tested to work with +[wernsey's chip8](https://github.com/wernsey/chip8) and +[sipsi-8](https://ahti.space/git/nortti/sipsi-8). Wernsey's Chip8 does not +support audio and draws pixels at the edges of the screen at the wrong +size. Sipsi-8 by default runs the game too slow, but you can tell it to run +it at 900 IPS. + + chip8 mato8.ch8 + sipsi-8.py mato8.ch8 900 + +License +------- +Mato8 is released under CC0 1.0.