OSVR Framework (Internal Development Docs)  0.6-1962-g59773924
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
doc/Building.md
1 # Building the Libraries {#Building}
2 
3 See the [OSVR Docs repo][] for more up-to-date and step-by-step instructions, including links to pre-compiled Windows binary dependencies.
4 
5 [OSVR Docs repo]:https://github.com/OSVR/OSVR-Docs
6 
7 The rest of the page you're currently reading is targeted at those interested in in-depth development (particularly across platforms), so it leaves a lot of blanks that it assumes you can fill in.
8 
9 For Windows:
10 
11 You'll need:
12 
13 - Git (make sure to clone OSVR-Core with `--recursive` flag to get all submodules)
14 - CMake, fairly recent (3.0 or newer, 3.0.2 most tested, that or the latest preferred.)
15 - A relatively recent version of Boost libraries(1.44 or newer, 1.57.0 on Windows the most tested, the latest is usually preferred barring any weird bugs which will be noted here if discovered.)
16  - Some had reported issues with Boost 1.58 due to [this issue](http://lists.boost.org/Archives/boost/2015/05/221933.php), but we now believe that the bug no longer affects OSVR-Core.
17 - [libfunctionality][] compiled
18 - [jsoncpp][] compiled, with the `JSONCPP_WITH_CMAKE_PACKAGE` option turned on, and the `JSONCPP_LIB_BUILD_SHARED` option turned off on Windows and on for other platforms.
19 - OpenCV - preferably 2.4.x - there is some initial work on porting to support 3.0 and 3.1 but it's not widely tested.
20 - A C++11 capable compiler: VS 2013 is the main one used in development. (VS 2012 doesn't support enough C++11 to build the core currently, and VS2015 Update 1 has compiler bugs that prevent it from working to build the core.) MSYS2 with MinGW64 GCC and GCC in the nuwen distro of MinGW also work, at least as of some time in the recent past. CI builds regularly on Linux using GCC and Clang, so ideally GCC in MinGW should also stay working, or at least not very broken.
21 
22 For Linux:
23 
24 You'll need:
25 
26 - Git (make sure to clone OSVR-Core with `--recursive` flag to get all submodules)
27 - Any reasonably recent Clang, GCC/G++ is fine for a compiler:
28 - CMake, fairly recent (3.0 or newer, 3.0.2 most tested, that or the latest preferred.) Depending on your Linux distribution, package manager may or may not have version 3.0+, so you can get it from <http://CMake.org> or backports/PPA.
29 - [libfunctionality][] is standalone, so you will need to build it first
30 - [jsoncpp][] - the version in your distribution is probably OK, but if you build it from source, you will need to compile it with `-DJSONCPP_WITH_CMAKE_PACKAGE=ON` in order to generate CMake project config files. Optionally you can make it a static library with ` -DJSONCPP_LIB_BUILD_SHARED=OFF -DCMAKE_CXX_FLAGS=-fPIC` flags (don't forget to `make install` after building)
31 - OpenCV 2.4.x
32 - Boost libraries (1.44 or newer - as mentioned above, Boost 1.58 was considered buggy but is now thought to be just fine), which you can get through package manager. You don't need all of them but you'll need at least : `libboost1.xx-dev, libboost-thread1.xx-dev (includes required system, date-time and chrono), libboost-program-options1.xx-dev, libboost-filesystem1.xx-dev)`
33 - `libusb1` - this is the Debian package `libusb-1.0-0-dev`. Do not confuse it with `libusb` aka `libusb0`: those packages are frozen in the past and incompatible with `libusb1`.
34 
35 [libfunctionality]:https://github.com/OSVR/libfunctionality
36 [jsoncpp]:https://github.com/VRPN/jsoncpp