Added README

Makefile

@@ -16,7 +16,10 @@ clean:
 
 libs: $(BUILD_DIR)/hid.o $(BUILD_DIR)/libmpdclient.o
 
-.PHONY: clean all run libs
+submodules:
+	git submodule update --init --recursive
+
+.PHONY: clean all run libs submodules
 
 #################################################
 # Flags and autodetection
@@ -28,11 +31,14 @@ CPPFLAGS := -MMD -MP \
 	-I libs/hidapi/hidapi \
 	-I libs/spdlog/include \
 	-I libs/libmpdclient/include \
-	-I libs/libmpdclient/output
+	-I libs/libmpdclient/output \
+	$(shell pkg-config --cflags hunspell)
 
 # udev: required by hidapi
-# TODO: better hunspell link
-LDFLAGS := -l fftw3 -l udev -l hunspell-1.7
+LDFLAGS := \
+	-l fftw3 \
+	-l udev \
+	$(shell pkg-config --libs hunspell)
 
 # Find all cpp files in source dirs
 SRCS := $(shell find $(SRC_DIRS) -name '*.cpp')
@@ -63,6 +69,8 @@ $(BUILD_DIR)/hid.o:
 
 # Build libmpdclient
 $(BUILD_DIR)/libmpdclient.o:
+	@mkdir -p $(BUILD_DIR)
+
 	@cd libs/libmpdclient && \
 		meson . output && \
 		ninja -C output

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.

src/main.cpp

@@ -11,10 +11,8 @@
 #include <thread>
 // MPD client
 #include "mpd/client.h"
-
-// TODO: Include this properly
-#include "/usr/include/hunspell/hunspell.hxx"
-
+// Spell checking
+#include "hunspell.hxx"
 // Local files
 #include "utility/bitmap.hpp"
 #include "utility/buffer.hpp"

src/utility/bitmap.cpp

@@ -1,5 +1,9 @@
 #include "bitmap.hpp"
 
+
+// Simple bitmap library.
+// Used to debug music visualizer.
+
 Bitmap::Bitmap(size_t w, size_t h) {
 	this->width = w;
 	this->height = h;