Skip to content

Latest commit

 

History

History
36 lines (26 loc) · 3.26 KB

Building.md

File metadata and controls

36 lines (26 loc) · 3.26 KB
Raw

Building the Libraries {#Building}

See the OSVR Docs repo for more up-to-date and step-by-step instructions, including links to pre-compiled Windows binary dependencies.

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.

For Windows:

You'll need:

  • Git (make sure to clone OSVR-Core with --recursive flag to get all submodules)
  • CMake, fairly recent (3.0 or newer, 3.0.2 most tested, that or the latest preferred.)
  • 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.)
    • Some had reported issues with Boost 1.58 due to this issue, but we now believe that the bug no longer affects OSVR-Core.
  • libfunctionality compiled
  • 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.
  • 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.
  • 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.

For Linux:

You'll need:

  • Git (make sure to clone OSVR-Core with --recursive flag to get all submodules)
  • Any reasonably recent Clang, GCC/G++ is fine for a compiler:
  • 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.
  • libfunctionality is standalone, so you will need to build it first
  • 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)
  • OpenCV 2.4.x
  • 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)
  • 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.