aboutsummaryrefslogblamecommitdiff
path: root/README.md
blob: 0b825ac28c9de357134c43093f3b48210798e999 (plain) (tree)















































                                                                   

                                                                  





                    
          

      
# 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
$ git clone https://git.windblume.net/pub/nick/clak
$ dnf install libX11-devel libXi-devel SDL2-devel SDL2_mixer-devel
$ make
```

To build the boards:

```sh
$ cd board
$ make
```