Skip to content
Permalink
Browse files

One-click build on Windows, updated README.md

  • Loading branch information...
tribal-tec committed Feb 15, 2015
1 parent dbbccf4 commit 2561167c1438a57b800c622672cc56d2fa591b67
Showing with 47 additions and 60 deletions.
  1. +1 −1 .gitsubprojects
  2. +28 −37 README.md
  3. +18 −22 build.bat
@@ -5,4 +5,4 @@ git_subproject(Pression https://github.com/Eyescale/Pression.git 4913b98)
git_subproject(hwsd https://github.com/Eyescale/hwsd.git f9c52d2)
git_subproject(Collage https://github.com/Eyescale/Collage.git 43377f3)
git_subproject(GLStats https://github.com/Eyescale/GLStats.git a542211)
git_subproject(Deflect https://github.com/BlueBrain/Deflect.git 6be7656)
git_subproject(Deflect https://github.com/BlueBrain/Deflect.git c453ca1)
@@ -1,52 +1,43 @@
# Equalizer Parallel Rendering Framework

Welcome to Equalizer, the standard middleware to create and deploy
parallel, scalable OpenGL applications. It enables applications to
benefit from multiple graphics cards, processors and computers to scale
the rendering performance, visual quality and display size. An Equalizer
application runs unmodified on any visualization system, from a simple
workstation to large scale graphics clusters, multi-GPU workstations and
Virtual Reality installations.
Welcome to Equalizer, the standard middleware to create and deploy parallel,
scalable OpenGL applications. It enables applications to benefit from multiple
graphics cards, processors and computers to scale the rendering performance,
visual quality and display size. An Equalizer application runs unmodified on any
visualization system, from a simple workstation to large scale graphics
clusters, multi-GPU workstations and Virtual Reality installations.

# Building from source
## Linux, Mac OS X

```
git clone https://github.com/Eyescale/Buildyard.git
cd Buildyard
git clone https://github.com/Eyescale/config.git config.eyescale
make Equalizer
mkdir build
cd build
cmake ..
make
```

## Windows
### Obtaining the source codes
Using [Buildyard](https://github.com/Eyescale/Buildyard), is the preferred method for building Equalizer:
If `CMake` and `git` are in PATH, run the following batch script to build using
Visual Studio 2013:
```
git clone https://github.com/Eyescale/Buildyard.git
cd Buildyard
git clone https://github.com/Eyescale/config.git config.eyescale
build.bat
```

### Building with CMake GUI
You may run `CMake`'s GUI to configure `Buildyard` folder. After configuration, open up `Buildyard.sln` and build `00_Main \ Equalizer` project (You may right click and hit `project only > build only Equalizer`).

### Building with command line
You may also use the appropriate prepackaged batch build files:

- `build_vc12.bat` for Visual Studio 2013
- `build_vc10.bat` for Visual Studio 2010

Run them within a shell that has `git.exe` and `cmake.exe` on its path. The batch file runs appropriate `MSBuild`, `CMake`, and `Buildyard` commands.

#### A note about BOOST + CMake on Windows
If your build fails with a `Could NOT find Boost` message, you may have a bad environment setup for `Boost` and `CMake`. To remedy this, `CMake` requires you to properly hint it to find your `Boost` distribution. Make sure you have the following variables set up:
## A note about BOOST + CMake on Windows
If your build fails with a `Could NOT find Boost` message, you may have a bad
environment setup for `Boost` and `CMake`. To remedy this, `CMake` requires you
to properly hint it to find your `Boost` distribution. Make sure you have the
following variables set up:

1. `BOOST_ROOT` pointing to your Boost root directory.
2. `BOOST_INCLUDEDIR` pointing to your Boost includes (usually where `BOOST_ROOT` points to).
3. `BOOST_LIBRARYDIR` pointing to your Boost binary directory (`lib32-msvc-12.0` for instance).
4. `Boost_ADDITIONAL_VERSIONS` having major, minor, and patch versions (separated by space).
5. *(optional)* `Boost_USE_STATIC_LIBS` set to `ON` if you want to statically link to `Boost`. (default is `OFF`)
6. *(optional)* `Boost_USE_MULTITHREAD` set to `ON` if you want to use `Boost` multi-threaded libraries. (default is `ON`)
2. `BOOST_INCLUDEDIR` pointing to your Boost includes (usually where
`BOOST_ROOT` points to).
3. `BOOST_LIBRARYDIR` pointing to your Boost binary directory
(`lib32-msvc-12.0` for instance).
4. `Boost_ADDITIONAL_VERSIONS` having major, minor, and patch versions
(separated by space).
5. *(optional)* `Boost_USE_STATIC_LIBS` set to `ON` if you want to statically
link to `Boost`. (default is `OFF`)
6. *(optional)* `Boost_USE_MULTITHREAD` set to `ON` if you want to use `Boost`
multi-threaded libraries. (default is `ON`)

An example set up would be (typed in Windows command prompt):
```
@@ -1,23 +1,19 @@
@echo off

set CMAKE="%PROGRAMFILES%\CMake 2.8\bin\cmake.exe"
set SUBWCREV="%PROGRAMFILES%\TortoiseSVN\bin\SubWCRev.exe"
set DESTINATION="C:\Equalizer"

call "%VS90COMNTOOLS%vsvars32.bat"

if not exist build\NUL md build
cd build

%CMAKE% -DCMAKE_BUILD_TYPE=Release -DCMAKE_BUILD_TYPE=Debug -G "NMake Makefiles" ..

nmake preinstall

%CMAKE% -DCOMPONENT=Unspecified -DCMAKE_INSTALL_PREFIX=%DESTINATION% -P cmake_install.cmake
%CMAKE% -DCOMPONENT=dev -DCMAKE_INSTALL_PREFIX=%DESTINATION% -P cmake_install.cmake
%CMAKE% -DCOMPONENT=tools -DCMAKE_INSTALL_PREFIX=%DESTINATION% -P cmake_install.cmake
%CMAKE% -DCOMPONENT=vmmlib -DCMAKE_INSTALL_PREFIX=%DESTINATION% -P cmake_install.cmake

%SUBWCREV% .. > "%DESTINATION%\include\eq\Version.txt"

@echo OFF
REM Simple one-click batch file for executing a Debug, x64 build using Visual
REM Studio 2013 aka vc12 compiler. Note that cmake.exe and git.exe must be part
REM of %PATH%.

REM load environment for Visual Studio 2013
call "%VS120COMNTOOLS%"vsvars32.bat

REM do initial configuration if required
if not exist build (
mkdir build
cd /D build
cmake .. -G "Visual Studio 12 Win64"
) else (
cd /D build
)

msbuild /p:Configuration=Debug;Platform=x64 /m ALL_BUILD.vcxproj
pause

0 comments on commit 2561167

Please sign in to comment.
You can’t perform that action at this time.