From 30422df0da09d2cdfeeb019dd6fce4f93ef9d49e Mon Sep 17 00:00:00 2001 From: Mark Date: Sat, 23 Jul 2022 12:48:41 -0700 Subject: [PATCH] Added README --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..46fe671 --- /dev/null +++ b/README.md @@ -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. \ No newline at end of file