funfriend/README.md

27 lines
544 B
Markdown

# funfriend
little desktop buddy for your computer
![](https://howto.smooch.computer/i/jgv5q.gif)
currently just kind of sits and wanders around
you can right click to catmode
config is in `~/.config/funfriend/` or `%AppData%/funfriend/` or `~/Library/Application Support/funfriend`
## installation
grab yourself `SDL2`, `SDL2_mixer` and `GLFW` development libraries, then run
```sh
shards install
shards build
```
## usage
run `bin/funfriend` from the same dir as the source (for assets and shaders)
alternatively, use `shards run`