Update README (#7)

pyk · web-flow · commit 67814b62076e · 2018-02-24T15:56:28.000+07:00
diff --git a/.gitignore b/.gitignore
@@ -1,13 +1,9 @@
-# Generated by CMake
-CMakeCache.txt
-CMakeFiles/
-Makefile
-cmake-tutorial
-cmake_install.cmake
-*.a
-*.o
+# Build directory
+build/
 
+# macOS
 .DS_Store
 
+# IDE
 /.idea/
-/cmake-build-*/
+/cmake-build-*/
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -3,13 +3,16 @@ cmake_minimum_required (VERSION 3.10)
 # Define the project
 project(cmake-tutorial)
 
+
 # Add definition for math library
 add_library(math src/math.cc)
 
+
 # Add definition for the cmake-tutorial binary
 add_executable(cmake-tutorial src/main.cc)
 target_link_libraries(cmake-tutorial math)
 
+
 # Third-party library
 include(ExternalProject)
 ExternalProject_Add(googletest
@@ -18,22 +21,30 @@ ExternalProject_Add(googletest
     GIT_TAG "master"
     CMAKE_ARGS -DCMAKE_INSTALL_PREFIX=${CMAKE_BINARY_DIR}/lib/installed
 )
+
+
 # Prevent build on all targets build
 set_target_properties(googletest PROPERTIES EXCLUDE_FROM_ALL TRUE)
 
+
 # Define ${CMAKE_INSTALL_...} variables
 include(GNUInstallDirs)
 
+
 # Specify where third-party libraries are located
 link_directories(${CMAKE_BINARY_DIR}/lib/installed/${CMAKE_INSTALL_LIBDIR})
 include_directories(${CMAKE_BINARY_DIR}/lib/installed/${CMAKE_INSTALL_INCLUDEDIR})
 
+
 # This is required for googletest
 find_package(Threads REQUIRED)
 
+
 # Test
 add_executable(math_test test/math_test.cc)
 target_link_libraries(math_test math gtest Threads::Threads)
+
+
 # Make sure third-party is built before executable
 add_dependencies(math_test googletest)
 set_target_properties(math_test PROPERTIES EXCLUDE_FROM_ALL TRUE)
diff --git a/README.md b/README.md
@@ -31,6 +31,7 @@ We will start from the basic on how to build the project using `c++(1)` only
 and a simple `Makefile`. Then we define the build in `CMakeLists.txt` and
 using `cmake(1)` to generate complex `Makefile` for us.
 
+
 ## Install CMake
 
 First of all, you need to install `cmake`. 
@@ -62,6 +63,7 @@ Or we can do the compile and linking on the separate steps
     c++ -c src/math.cc -o math.o 
     c++ src/main.cc math.o -o cmake-tutorial
 
+
 ## Using Makefile
 
 We can automate the step to compile and link above using `Makefile`.
@@ -87,6 +89,7 @@ the subsequent command will do nothing:
 
 this is useful when working on larger project, we only compile the object that changes.
 
+
 ## Using CMake
 
 Now we know how to perform compiling and linking using the `C++` and `make` command.
@@ -110,6 +113,12 @@ We can generate the `Makefile` based on the definition above using the following
 
     cmake .
 
+Or create a `build` directory to store the generated files by CMake:
+
+    mkdir build
+    cd build/
+    cmake ..
+
 Now we can run `make cmake-tutorial` to build the binary.
 
     % make cmake-tutorial
@@ -122,6 +131,11 @@ Now we can run `make cmake-tutorial` to build the binary.
     [100%] Linking CXX executable cmake-tutorial
     [100%] Built target cmake-tutorial
 
+Or we can use the CMake directly via:
+
+    cmake --build . --target cmake-tutorial
+
+
 ## Using CMake with 3rd-party library
 
 Suppose that we want to write a unit test for `math::add(a, b)`.
@@ -159,11 +173,12 @@ Add the following definition to `CMakeLists.txt`:
 
 Re-generate the build files using the following command:
 
-    cmake .
+    cd build/
+    cmake ..
 
 Build the unit test:
 
-    make math_test
+    cmake --build . --target math_test
 
 Run the test:
 
