Anjing

##Dependency :##

• OpenGL 3.0
• GLEW 1.12.0
• SDL 2.0.3
• Doxygen 1.8.10 (for docs)
• CMake 3.1.0
• Google Test 1.7.0 (included in source)
• C++ 11 supported compiler (msvc & clang-cl for windows, and gcc & clang for linux/osx)

##For windows :##

• add folder /windows/bin to your path
• Visual Studio 2015

##How to build:##

• go to folder build, and run this from terminal in linux/osx or cmd in windows: "cmake ..".
• the previous step will make all necessary build files according to the platform.
• or run one of .bat (if on windows) or .sh (if on linux) to generate the build files.
• if you're on linux/osx, do "make install", and then the program will be build in the project's root folder.
• if you're on windows,
  • open the visual studio .sln file,
  • set the myapp project as the startup project, and build that project.

##Program's argument :##

• -y : automatically close the command line program after the main window closes

##Documentation :## http://bysreg.github.io/anjing/index.html

##Updating Doxygen Documentation :##

• go to /docs, and then run "doxygen" in terminal or cmd
• to update the documentation on the anjing's github page :
  • switch to gh-pages branch
  • merge with the origin's master branch
  • go to /docs, and then run "doxygen" in terminal or cmd
  • note that, HTML_OUTPUT in Doxyfile is set to the project root folder instead of /docs

##Building with GTest switched on:##

• if on linux,
  • you need to build gtest first, and put the libgtest.a nd libgtest-main.a to /usr/lib
• use "cmake -Dbuild_test=ON .."
• if on windows,
  • build solution
  • build RUN_TESTS, you can see the test's result in Output window in visual studio
• if on linux,
  • run "make" to build all executables, including the tests
  • run "make test" to run all the tests

##Building Debug or Release:##

• this only matters for linux or osx because in windows, you can switch the build mode inside Visual Studio
• supply argument CMAKE_BUILD_TYPE=Debug or CMAKE_BUILD_TYPE=Release to cmake to build respective configuration
• example (run inside build folder) : cmake -DCMAKE_BUILD_TYPE=Debug ..

##Building with code coverage report:##

• currently only works on linux & osx and it has to be compiled in debug mode (CMAKE_BUILD_TYPE==Debug)
• supply -Dgen_coverage=ON to cmake

##C++ 11 features needed :##

• Deleted functions, as defined in http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2007/n2346.htm
• Null pointer, as defined in http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2007/n2431.pdf
• Strongly typed enums, as defined in http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2007/n2347.pdf
• Override keyword
• Using to replace typedef

##Notes :##

• Windows and iOS use OpenGL 3.3, while Linux uses OpenGL 3.0. OSX can only use OpenGL core profile 3.2 (3.3/4.1 in OS X 10.9), aside from that you'll get OpenGL 2.1 instead. Linux is set to use OpenGL 3.0 because currently Travis CI can only support up to OpenGL 3.0 (if you request more than that, it will fail on OpenGL context creation)