Add build instructions

2020-06-21 18:00:40 +02:00
parent c776bc32d6
commit 3d0866eb49
1 changed files with 26 additions and 0 deletions
--- a/README.md
+++ b/README.md
@@ -1,2 +1,28 @@
 # AdaptiveBrightness

+## Build instructions
+
+### Build on windows
+
+#### Prerequisites
+
+- Visual Studio 2019
+- Qt Visual Studio Tools
+- Qt Library
+
+#### Build steps
+
+Open the `sln` and build.
+
+### Build on linux
+
+#### Prerequisites
+
+Assumes Debian Buster: `sudo apt install qt5-default libqt5serialport5-dev`
+
+#### Build steps
+
+```console
+$ qmake CONFIG+=release # or CONFIG+=debug
+$ make
+```