Update documentation wrt CMAKE_BUILD_TYPE

nicklan · Jun 12, 2018 · 06beb62 · 06beb62
1 parent 903298b
commit 06beb62
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 3 deletions.
diff --git a/HACKING.md b/HACKING.md
@@ -13,10 +13,17 @@ Table of Contents
 Getting Started
 ---------------
 
-At first, be sure to run PNMixer from the root directory, otherwise it won't
+Build PNMixer:
+
+    mkdir build
+    cd build
+    cmake -DCMAKE_BUILD_TYPE=Debug ..
+    make
+
+Be sure to run PNMixer from the build directory, otherwise it won't
 find the data files.
 
-	cd build
+	cd build # if you haven't already
 	./src/pnmixer
 
 To switch on debug messages, invoke PNMixer with the `-d` command-line option.

diff --git a/README.md b/README.md
@@ -119,7 +119,7 @@ To __install__ this program cd to this directory and run:
 
     mkdir build
     cd build
-    cmake ..
+    cmake -DCMAKE_BUILD_TYPE=Release ..
     make
     make install