Added build instrucitons to readme

visrealm · Sep 3, 2023 · 9b4f460 · 9b4f460
1 parent 219b666
commit 9b4f460
Showing 1 changed file with 32 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -34,6 +34,38 @@ The goal is to emulate all documented modes listed in the [TMS9918A/TMS9928A/TMS
 #### Multicolor Mode Demo
 <img src="res/mcdemo.gif" alt="Multicolor Mode Demo" width="1279px">
 
+## Building
+
+vrEmuTms9918 uses the CMake build system
+
+#### Checkout repository
+
+```
+git clone https://github.com/visrealm/vrEmuTms9918.git
+cd vrEmuTms9918
+```
+
+#### Setup build
+
+```
+mkdir build
+cd build
+cmake ..
+```
+
+#### Build
+
+```
+cmake --build .
+```
+Windows: Optionally, open the generated solution file
+
+#### Run tests
+```
+ctest
+```
+Windows: Optionally, build the ALL_TESTS project in the generated solution file
+
 ## Quick start
 
 ```c