diff options
| author | Nicholas Tay <nick@windblume.net> | 2022-05-17 19:20:39 +1000 |
|---|---|---|
| committer | Nicholas Tay <nick@windblume.net> | 2022-05-17 19:20:39 +1000 |
| commit | 7493b160d6a2be352d4379c5a24a05673adc6eb7 (patch) | |
| tree | d7624d3131fc01be6c3e5176e4570811337b1975 | |
| parent | d3ea90f183a1742fe205f06ec6543f65869a6799 (diff) | |
| download | clak-7493b160d6a2be352d4379c5a24a05673adc6eb7.tar.gz clak-7493b160d6a2be352d4379c5a24a05673adc6eb7.tar.bz2 clak-7493b160d6a2be352d4379c5a24a05673adc6eb7.zip | |
Add README
| -rw-r--r-- | README.md | 57 |
1 files changed, 57 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..ff964a3 --- /dev/null +++ b/README.md @@ -0,0 +1,57 @@ +# clak + +Another Meccha / mechanical-sound... + +## Usage + +```sh +$ ./clak <board name> +``` + +That's it. + +## Requirements + +Should work on Windows and Linux. + +For Linux, specific requirements are: + +- Xlib (Fedora: `libX11`) +- XI2 (Fedora: `libXi`) +- SDL2 (Fedora: `SDL2`) +- SDL\_mixer 2 (Fedora: `SDL2_mixer`) + +## Building + +### Requirements + +You need: + +- C compiler (tested with gcc) +- make +- xxd + +For Windows: + +- Only tested with MinGW +- (TODO: fill in requirements, this stuff was already on my PC lol) + +For Linux: + +- Xlib (Fedora: `libX11-devel`) +- XI2 dev (Fedora: `libXi-devel`) +- SDL2 dev (Fedora: `SDL2-devel`) +- SDL\_mixer 2 dev (Fedora: `SDL2_mixer-devel`) + +### Compiling + +```sh +$ make +``` + +To build the boards: + +```sh +$ cd boards +$ make +``` |