diff options
| -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 +``` |