aboutsummaryrefslogblamecommitdiff
path: root/README.md
blob: 5338d33f94263273ea0f1dafe9dc466093b00b92 (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:

- (Might have other ways, but I've only tested this way)
- MinGW-w64 (via MSYS2)
	- `mingw-w64-x86_64-make`
	- `mingw-w64-x86_64-gcc`
- Note to use `mingw32-make` in place of just `make`

For Linux, also:

- 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
```