Added README

master
Mark 2022-07-23 12:48:41 -07:00
parent dcfe86f661
commit 30422df0da
Signed by: Mark
GPG Key ID: AD62BB059C2AAEE4
1 changed files with 25 additions and 0 deletions

25
README.md Normal file
View File

@ -0,0 +1,25 @@
# Ergodox Host Interface
Host software for [Betalupi Ergodox](https://git.betalupi.com/Mark/QMK).
## Features:
- Music visualizer ([here](https://git.betalupi.com/Mark/hostdox/src/branch/master/src/signal_processing))
- Spell checking with hunspell
-------------------------------------------------
## Dependencies:
Run:
- hunspell
Build:
- meson (for libmpdclient)
- ninja (for libmpdclient)
- gcc
-------------------------------------------------
## Building
``make submodules`` to initialize git submodules \
``make all`` to build, or ``make run`` to build and run.