diff --git a/README.md b/README.md new file mode 100644 index 0000000..bf580a4 --- /dev/null +++ b/README.md @@ -0,0 +1,19 @@ +# Slide Controller 9000 + +## Build Prerequisites + +* Install GCC, Clang, or Visual Studio with C++20 support +* Install Python 3 +* Install Ninja, Make, and CMake +* [Qt6](https://www.qt.io/download-qt-installer-oss) (Network and Widgets) +* Consider also installing ccache for faster subsequent build times + +## Build + +Build options: release, debug, asan + + make purge configure-{release,debug,asan} install + +## Run + + make run