Skip to content

Commit

Permalink
Updated README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
willyd committed Oct 7, 2016
1 parent f6e22fb commit b060e7f
Showing 1 changed file with 23 additions and 22 deletions.
45 changes: 23 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,50 +1,51 @@
# Super-Builder
Super-Builder (previously known as Caffe-Builder) is a set of CMake scripts (using CMake's ExternalProject) that automate the build and installation of popular C/C++ open source libraries on Windows using microsoft toolchain.
# Caffe-Builder
Caffe-Builder is a set of CMake scripts (using CMake's ExternalProject) that automate the build and installation of popular C/C++ open source libraries on Windows using microsoft toolchain.

Using this project will (hopefully) make building, installing and using open source libraries on Windows much easier.
Using this project will (hopefully) make building, installing and using open source libraries on Windows much easier.

[![Build status](https://ci.appveyor.com/api/projects/status/cks08mgov46p76y6/branch/master?svg=true)](https://ci.appveyor.com/project/willyd/caffe-builder/branch/master)

## Building libraries
### Get the Prerequisites
* CMake (tested with 3.4)
* Visual Studio (tested with 2013 in 64 bit mode)
* CMake (tested with 3.4 and 3.6)
* Visual Studio (tested with 2013 and 2015 in 64 bit mode)
* Git
* [Ninja](https://github.com/ninja-build/ninja/releases/download/v1.6.0/ninja-win.zip)

Make sure CMake, Git and Ninja are in your path.

### Optional dependencies
* CUDA (tested with 7.0) for GPU support in opencv and other libraries
* CUDA (tested with 7.5) for GPU support in opencv and other libraries
* Python (tested with 2.7.x) to build boost.python for example

### Clone this repository:
cmd> cd %super_builder_root%
cmd> git clone https://github.com/willyd/super-builder.git super-builder
### Create a build directory and configure CMake to build super-builder inside:
cmd> mkdir build
cmd> cd build
:: Set the Visual Studio envrionment for ninja (120 -> Visual Studio 2013, 64 -> amd64)
cmd> ..\setenv.cmd 120 64
:: Configure cmake
cmd> cmake -GNinja -C ..\cmake\configs\Default.cmake ..\

### Build and installing the libraries
cmd> cd %caffe_builder_root%
cmd> git clone https://github.com/willyd/caffe-builder.git caffe-builder

### Building the libraries
Execute the following command to build the libraries

cmd> build_v120_x64.cmd

Alternatively you can execute one command after the other
:: Create a build directory
cmd> mkdir build && cd build
:: Setup the VS compiler
cmd> call "%VS120COMNTOOLS%..\..\VC\vcvarsall.bat" amd64
:: This will build all libraries that were configured to build with the BUILD_* options (see below)
cmd> ninja
:: Or alternatively
cmd> ninja <libname>
:: You can execute this command to list all possible targets
cmd> ninja -t targets
The libraries will be installed in build\install. Alongside the libraries a series of Find*.cmake files will be installed and a InitialCache.cmake file will be installed too.

The libraries will be installed in build\libraries. Alongside the libraries a series of Find*.cmake files will be installed and a caffe-builder-config.cmake file will be installed too. You can replace `120` with `140` in the commands above to build with VS 2015.

### Using the built libraries in your project
cmd> cd myproject
cmd> mkdir build
cmd> cd build
cmd> cmake -G <generator name> -C %super_builder_root%\super-builder\build\install\InitialCache.cmake
cmd> cmake -G <generator name> -C %caffe_builder_root%\caffe-builder\build\libraries\caffe-build-config.cmake



Expand Down

0 comments on commit b060e7f

Please sign in to comment.