Browse Source

Add requirements

Johannes Kreutz 2 years ago
parent
commit
87777b0e88
1 changed files with 7 additions and 2 deletions
  1. 7 2
      README.md

+ 7 - 2
README.md

@@ -5,6 +5,11 @@ Git project for my bachelor thesis
 # TrackpointApp
 ## Development
 
+Requirements:
+- A recent C++ Compiler (only `gcc` is tested)
+- The CMake build system
+- CPU power ;)
+
 Note: Development on Windows is unsupported.
 
 To create a development build, clone the repo and go to the `trackpoint-app` folder.
@@ -13,9 +18,9 @@ Create a new folder `build`.
 
 Qt has to be build separately, we use a script for it. Build Qt by executing `./build-dependencies-first.sh`.
 
-Then, go to the `build` folder and execute `cmake ..`. Cmake will download all other required dependencies automatically.
+Then, go to the `build` folder and execute `cmake ..`. CMake will download all other required dependencies automatically.
 
-When cmake is done, run `make`. For better performance, run `make -jX` and replace X by the thread count of your machine minus 1.
+When CMake is done, run `make`. For better performance, run `make -jX` and replace X by the thread count of your machine minus 1.
 
 You should now find the executable `TrackpointApp`.