Skip to content

Commit

Permalink
Updted documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
Vertexwahn committed Dec 16, 2017
1 parent 5355824 commit c3c1a93
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 13 deletions.
17 changes: 9 additions & 8 deletions Docs/Building.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

### Get the source code

Checkout the source from Bitbucket (https://bitbucket.org/tumcms/blueframework3-public) using the Mercurial Hg version control system. Mercurial is a distributed source control management tool. It can be downloaded from http://mercurial.selenic.com/. After installing you can clone a repository. For instance, to clone the Eigen repository (https://bitbucket.org/eigen/eigen) you can type `hg clone ssh://[email protected]/eigen/eigen `into a console window or you can use the graphical user interface:
Checkout the source from Bitbucket (https://bitbucket.org/tumcms/blueframework) using the Mercurial Hg version control system. Mercurial is a distributed source control management tool. It can be downloaded from http://mercurial.selenic.com/. After installing you can clona a repository. For instance, to clone the Eigen repository (https://bitbucket.org/eigen/eigen) you can type `hg clone ssh://[email protected]/eigen/eigen `into a console window or you can use the graphical user interface:

![TortoiseHg](images/thgui.png)

Expand All @@ -18,24 +18,25 @@ To check out the source code of the BlueFramwork proced as describe in the follo

1. Install mercurial from http://mercurial.selenic.com/. It comes with TortoiseHg on Windows:
![TortoiseHg](images/thg.png)
2. Now clone the code by typing `hg clone https://bitbucket.org/tumcms/blueframework3-public`
2. Now clone the code by typing `hg clone https://bitbucket.org/tumcms/blueframework`

### Third-party dependencies

Install the following third-party libraries
Install the following third-party libraries:

1. Windows 10 SDK (https://developer.microsoft.com/en-us/windows/downloads/windows-10-sdk)
**Windows 10 SDK** (https://developer.microsoft.com/en-us/windows/downloads/windows-10-sdk)

2. Boost: 1.65.1: Download a prebuild version from https://sourceforge.net/projects/boost/files/boost-binaries/1.65.1/ or build it yourself. For the second option you can use BlueGo see https://bitbucket.org/Vertexwahn/bluego) or one of the build scripts provided here: https://bitbucket.org/Vertexwahn/percdems
**Boost: 1.65.1**: Download a prebuild version from https://sourceforge.net/projects/boost/files/boost-binaries/1.65.1/ or build it yourself.
Not all parts of boost are required. You just need: filesystem, python, signals and system.

![BlueGo](images/BlueGo.png)
Building Boost can take some time and consumes a lot of disk space. To build it faster with less memory wastage you can build only the parts of boost that are needed. Use this command:
`C:\thirdparty\vs2017\x64\boost_1_65_1>b2 address-model=64 toolset=msvc-14.1 --build-type=complete stage --with-filesystem --with-signals --with-system --with-date_time --with-regex`

3. Qt 5.9.2 from https://www.qt.io/
The percdems repository (https://bitbucket.org/Vertexwahn/percdems) contains some build scripts to build librareis such as Boost.

**Qt 5.10.0** from https://www.qt.io/

## How to build BlueFramework with CMake Step by Step

BlueFramework version 3.0.0.0 and up compiles with Visual Studio 2017 x64 (Version 15.4.1). Currently, we are not aiming at supporting any other compilers.
BlueFramework version 3.0.0.0 and up compiles with Visual Studio 2017 x64 (Version 15.4.4). Currently, we are not aiming at supporting any other compilers.

Binary file removed Docs/images/BlueGo.png
Binary file not shown.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,8 @@ The **Engine** module over functionality to download resources such as textures

### Ether.DebugVisualizer
![OIP](Docs/images/Ether.DebugVisualizer.png)
[Country Kitchen](https://www.blendswap.com/blends/view/42851) scene by [Jay-Artist](https://www.blendswap.com/user/Jay-Artist)

([Country Kitchen](https://www.blendswap.com/blends/view/42851) scene by [Jay-Artist](https://www.blendswap.com/user/Jay-Artist))

## Documentation

Expand Down Expand Up @@ -55,16 +56,16 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
## Copyright notes
BlueFramework version 3.0.0.0 and up uses several software libraries. The corresponding licenses can be found in the Licenses folder distributed with this source code:

* boost 1.63.0 (http://www.boost.org/) (*Boost Software License*) ({root_dir}/Licenses/boost.LICENSE_1_0.txt)
* Eigen 3.3.3 (http://eigen.tuxfamily.org/) (*MPL2*) ({root_dir}/Licenses/Eigen.COPYING.MPL2)
* boost 1.65.1 (http://www.boost.org/) (*Boost Software License*) ({root_dir}/Licenses/boost.LICENSE_1_0.txt)
* Eigen 3.3.4 (http://eigen.tuxfamily.org/) (*MPL2*) ({root_dir}/Licenses/Eigen.COPYING.MPL2)
* Google Test 1.8.0 (https://github.com/google/googletest) (*BSD 3-Clause License*) ({root_dir}/Licenses/GoogleTest.LICENSE)
* TinyXML-2 (https://github.com/leethomason/tinyxml2) (zlib license) ({root_dir}/Licenses/TinyXML-2.txt)
* Qt 5.9.1 (http://doc.qt.io/qt-5/lgpl.html) (LGPL version 3) ({root_dir}/Licenses/Qt.LGPL_version_3.txt)
* OGRE3D (http://www.ogre3d.org/) (MIT License) ({root_dir}/Licenses/OGRE3D.MIT.txt)
* Qt 5.10.0 (http://doc.qt.io/qt-5/lgpl.html) (LGPL version 3) ({root_dir}/Licenses/Qt.LGPL_version_3.txt)
* glew 2.0.0 (http://glew.sourceforge.net/) (*Modified BSD License, the Mesa 3-D License (MIT) and the Khronos License (MIT)*) ({root_dir}/Licenses/glew.LICENSE.txt)

Some code has also been copied from the following projects:

* OGRE3D (http://www.ogre3d.org/) (MIT License) ({root_dir}/Licenses/OGRE3D.MIT.txt)
* API DESIGN FOR C++ (http://www.apibook.com/) (MIT license) ({root_dir}/Licenses/apibook.LICENSE)
* appleseed (http://appleseedhq.net/) (MIT license) ({root_dir}/Licenses/appleseed.LICENSE.txt)
* CML (Configurable Math Library) (Boost Software License) ({root_dir}/Licenses/CML.LICENSE.txt)
Expand Down

0 comments on commit c3c1a93

Please sign in to comment.