Revise README.md and add instruction to run example codes

Author: sunglok

.gitignore

@@ -1,7 +1,8 @@
 data/KITTI07/image_0
 slides
-build
 
+__pycache__
+build
 x64
 Debug
 Release

CMakeLists.txt

@@ -1,20 +1,32 @@
-cmake_minimum_required(VERSION 2.6)
-
+cmake_minimum_required(VERSION 3.8)
 project(3dv_tutorial)
-set(CMAKE_CXX_STANDARD 11)
-set(CMAKE_BUILD_TYPE Release)
+
+# Find external packages and specify their locations
 find_package(OpenCV REQUIRED)
 find_package(Ceres REQUIRED)
 
-set(SRC_DIR	"${CMAKE_SOURCE_DIR}/examples")
-set(BIN_DIR	"${CMAKE_SOURCE_DIR}/bin")
+# Specify project files and locations
+set(EXAMPLE_DIR	"${CMAKE_SOURCE_DIR}/examples")
+file(GLOB EXAMPLE_FILES ${EXAMPLE_DIR}/*.cpp)
+
+# Set common configuration
+include_directories(
+    ${OpenCV_INCLUDE_DIRS}
+    ${Ceres_INCLUDE_DIRS}
+)
+link_directories(
+    ${OpenCV_LIB_DIRS}
+    ${Ceres_LIB_DIRS} 
+)
+link_libraries(
+    ${OpenCV_LIBS}
+    ${CERES_LIBRARIES} 
+)
+add_compile_definitions(GLOG_NO_ABBREVIATED_SEVERITIES)
 
-file(GLOB APP_SOURCES "${SRC_DIR}/*.cpp")
-foreach(app_source ${APP_SOURCES})
-    string(REPLACE ".cpp" "" app_name ${app_source})
-    string(REPLACE "${SRC_DIR}/" "" app_name ${app_name})
-    add_executable(${app_name} ${app_source})
-    target_include_directories(${app_name} ${CERES_INCLUDE_DIRS})
-    target_link_libraries(${app_name} ${OpenCV_LIBS} ${CERES_LIBRARIES})
-    install(TARGETS ${app_name} DESTINATION ${BIN_DIR})
-endforeach(app_source ${APP_SOURCES})
+# Add an executable
+foreach(example_file ${EXAMPLE_FILES})
+    string(REPLACE ".cpp"            "" example_name ${example_file})
+    string(REPLACE "${EXAMPLE_DIR}/" "" example_name ${example_name})
+    add_executable(${example_name} ${example_file})
+endforeach()

HOWTO_RUN.md

@@ -0,0 +1,55 @@
+## How to Run Example Codes with Microsoft Visual Studio
+### Prerequisites
+* Install [Microsoft Visual Studio](https://www.visualstudio.com/) (shortly MSVS)
+  * :memo: Note) Microsoft Visual Studio **Community** is _free_ for students, open-source contributors, and individual developers.
+* Install [Git](https://git-scm.com/) and  [CMake](https://cmake.org/)
+  * You need to [add their directory to PATH environment in Windows](https://stackoverflow.com/questions/44272416/how-to-add-a-folder-to-path-environment-variable-in-windows-10-with-screensho).
+* Install [vcpkg](https://vcpkg.io/) ([more details](https://vcpkg.io/en/getting-started))
+  * You need to move your working directory where you want to install _vcpkg_ (I assume your working directory as `C:/`).
+  ```bash
+  git clone https://github.com/Microsoft/vcpkg.git
+  .\vcpkg\bootstrap-vcpkg.bat
+  ```
+* Install [OpenCV](https://opencv.org/) and [Ceres Solver](http://ceres-solver.org/) using _vcpkg_
+  ```bash
+  cd vcpkg
+  vcpkg install opencv[world,contrib]:x64-windows --recurse
+  vcpkg install ceres[suitesparse,cxsparse,eigensparse,tools]:x64-windows
+  vcpkg integrate install
+  ```
+
+### Compiling and Running Examples
+1. Clone the repository: `git clone https://github.com/mint-lab/3dv_tutorial.git`
+    * You need to move your working directory where you want to copy the repository.
+    * Or you can download [example codes and slides as a ZIP file](https://github.com/sunglok/3dv_tutorial/archive/master.zip) and unzip it where you want.
+1. Generate MSVS solution and project files
+    * You need to specify the _vcpkg_ directory where you installed it. (I assume you install it at `C:/`)
+    ```bash
+    cd 3dv_tutorial
+    mkdir build
+    cd build
+    cmake .. "-DCMAKE_TOOLCHAIN_FILE=C:/vcpkg/scripts/buildsystems/vcpkg.cmake"
+    ```
+1. Run your MSVS and open the generated solution file, `build/3dv_tutorial.sln`.
+1. Build the example codes in the solution (Menu > `Build` > `Build Solution`)
+1. Run the examples using `F5` after specify your target as the startup project (Project Context Menu > `Set as Startup Project`)
+
+
+
+## How to Run Example Codes in Linux
+### Prerequisites
+* Install [GCC](https://gcc.gnu.org/), [Git](https://git-scm.com/), [CMake](https://cmake.org/), [OpenCV](https://opencv.org/), and [Ceres Solver](http://ceres-solver.org/)
+
+### Running Examples
+1. Clone the repository: `git clone https://github.com/mint-lab/3dv_tutorial.git`
+    * You need to move your working directory where you want to copy the repository.
+    * Or you can download [example codes and slides as a ZIP file](https://github.com/sunglok/3dv_tutorial/archive/master.zip) and unzip it where you want.
+1. Generate `Makefile` and project files
+    ```bash
+    cd 3dv_tutorial
+    mkdir build
+    cd build
+    cmake ..
+    make install
+    ```
+1. Run the examples

HOWTO_RUN_CPP.md

@@ -0,0 +1,21 @@
+## How to Run Python Example Codes
+
+### Prerequisites
+* Install [Python](https://www.python.org/) (or [Anaconda](https://www.anaconda.com/))
+* Install the following required packages: `pip install -r requirements.txt`
+  ```
+  numpy
+  matplotlib
+  scipy
+  opencv-python
+  opencv-contrib-python
+  ```
+* Clone the repository: `git clone https://github.com/mint-lab/3dv_tutorial.git`
+  * You need to move your working directory where you want to copy the repository.
+  * Or you can download [example codes and slides as a ZIP file](https://github.com/sunglok/3dv_tutorial/archive/master.zip) and unzip it where you want.
+
+
+### Running Examples in Console
+1. Move to the directory where example codes exist: `cd examples`
+2. Run an example (e.g. `image_formation.py`): `python image_formation.py`
+    * Or you can run an example on your favorite Python IDE or editor.