<commit_before>3D Repo GUI
=========

Cross-platform C++ GUI written in Qt.

## License
This project is Copyright of [3D Repo Ltd](http://3drepo.org) and is released under the open source [GNU Affero General Public License v3](http://www.gnu.org/licenses/agpl-3.0.en.html). Should you require a commercial license, please contact [<EMAIL>](mailto:<EMAIL>)

## Dependencies

- [3D Repo Bouncer master branch](https://github.com/3drepo/3drepobouncer)
- [GLC Lib v2.5.1](https://github.com/laumaya/GLC_lib/tree/Version_2_5_1)
- [Font Awesome v4.3.0](https://github.com/FortAwesome/Font-Awesome/tree/v4.3.0)
- [Qt v5.4.1 OpenGL](https://www.qt.io/download-open-source/#section-2)
- [Python v2.x] (https://www.python.org/)
- [Boost v1.58] (http://www.boost.org/)

## General Compilation instruction

This project uses qmake as the compilation procedure. The easiest way to build this will be to open the qt project using QT Creator and operate on the GUI interface. For more information about qmake, see [http://doc.qt.io/qt-4.8/qmake-using.html]

External libraries are referenced via environment variables. Please ensure the followings are set to the correct directories:
 - ASSIMP_ROOT
 - BOOST_ROOT
 - REPOBOUNCER_ROOT
 - GLC_ROOT
 - MONGO_ROOT

Libraries are referenced within 3drepogui.pro, you may wish to view and alter this where appropriate.

Before compilation, 3drepogui.pri file is up to date. This can be done by running the provided python script `python updateSources.py`

## Compiling on Windows

### Qt

Download and install Qt with an explicit OpenGL support.
For Windows, download also [WinDbg](http://msdn.microsoft.com/en-us/windows/hardware/hh852365), see [http://qt-project.org/doc/qtcreator-2.6/creator-debugger-engines.html](http://qt-project.org/doc/qtcreator-2.6/creator-debugger-engines.html).


QtSSL
Download the openSSL libraries for the integrated web browser
http://gnuwin32.sourceforge.net/packages/openssl.htm


### ICU

Download pre-compiled ICU libraries for MSVC 2010, 2012 and 2013 directly from Qt: [http://download.qt-project.org/development_releases/prebuilt/icu/prebuilt/](http://download.qt-project.org/development_releases/prebuilt/icu/prebuilt/)
See also [http://qt-project.org/wiki/Compiling-ICU-with-MSVC](http://qt-project.org/wiki/Compiling-ICU-with-MSVC)

### OpenSSL

Download pre-compiled OpenSSL binaries from [https://www.openssl.org/related/binaries.html](https://www.openssl.org/related/binaries.html). Either add them to the Path variable or copy the DLLs next to the 3D Repo executable.

## Compiling on Mac

These instructions are for OSX Yosemite.

### Qt

Download and install Qt with an explicit OpenGL support.

Navigate to where you installed Qt using finder.
Go to the subdirectory 5.3/clang_64/mkspecs directory.
Open the file called qdevice.pri with a text editor
Change the line !host_build:QMAKE_MAC_SDK = macosx10.8 to !host_build:QMAKE_MAC_SDK = macosx10.9
Save the file and restart Qt Creator.

### GLC Lib

On Mac you will need to compile GLC Lib separately. To do so, navigate to the submodule directly, and run the following command:

```
qmake -recursive
make -j8
```
<commit_msg>ISSUE #40 fix my inability to write in proper prose!<commit_after>3D Repo GUI
=========

Cross-platform C++ GUI written in Qt.

## License
This project is Copyright of [3D Repo Ltd](http://3drepo.org) and is released under the open source [GNU Affero General Public License v3](http://www.gnu.org/licenses/agpl-3.0.en.html). Should you require a commercial license, please contact [<EMAIL>](mailto:<EMAIL>)

## Dependencies

- [3D Repo Bouncer master branch](https://github.com/3drepo/3drepobouncer)
- [GLC Lib v2.5.1](https://github.com/laumaya/GLC_lib/tree/Version_2_5_1)
- [Font Awesome v4.3.0](https://github.com/FortAwesome/Font-Awesome/tree/v4.3.0)
- [Qt v5.4.1 OpenGL](https://www.qt.io/download-open-source/#section-2)
- [Python v2.x] (https://www.python.org/)
- [Boost v1.58] (http://www.boost.org/)

## General Compilation instruction

This project uses qmake as the compilation procedure. The easiest way to build this will be to open the qt project using QT Creator and operate on the GUI interface. For more information about qmake, see [http://doc.qt.io/qt-4.8/qmake-using.html]

External libraries are referenced via environment variables. Please ensure the followings are set to the correct directories:
 - ASSIMP_ROOT
 - BOOST_ROOT
 - REPOBOUNCER_ROOT
 - GLC_ROOT
 - MONGO_ROOT

Libraries are referenced within 3drepogui.pro, you may wish to view and alter this where appropriate.

Before compilation, make sure 3drepogui.pri file is up to date. This can be done by running the provided python script `python updateSources.py`

## Compiling on Windows

### Qt

Download and install Qt with an explicit OpenGL support.
For Windows, download also [WinDbg](http://msdn.microsoft.com/en-us/windows/hardware/hh852365), see [http://qt-project.org/doc/qtcreator-2.6/creator-debugger-engines.html](http://qt-project.org/doc/qtcreator-2.6/creator-debugger-engines.html).


QtSSL
Download the openSSL libraries for the integrated web browser
http://gnuwin32.sourceforge.net/packages/openssl.htm


### ICU

Download pre-compiled ICU libraries for MSVC 2010, 2012 and 2013 directly from Qt: [http://download.qt-project.org/development_releases/prebuilt/icu/prebuilt/](http://download.qt-project.org/development_releases/prebuilt/icu/prebuilt/)
See also [http://qt-project.org/wiki/Compiling-ICU-with-MSVC](http://qt-project.org/wiki/Compiling-ICU-with-MSVC)

### OpenSSL

Download pre-compiled OpenSSL binaries from [https://www.openssl.org/related/binaries.html](https://www.openssl.org/related/binaries.html). Either add them to the Path variable or copy the DLLs next to the 3D Repo executable.

## Compiling on Mac

These instructions are for OSX Yosemite.

### Qt

Download and install Qt with an explicit OpenGL support.

Navigate to where you installed Qt using finder.
Go to the subdirectory 5.3/clang_64/mkspecs directory.
Open the file called qdevice.pri with a text editor
Change the line !host_build:QMAKE_MAC_SDK = macosx10.8 to !host_build:QMAKE_MAC_SDK = macosx10.9
Save the file and restart Qt Creator.

### GLC Lib

On Mac you will need to compile GLC Lib separately. To do so, navigate to the submodule directly, and run the following command:

```
qmake -recursive
make -j8
```

{'fraction_non_alphanumeric': 0.11172305271439811, 'fraction_numerical': 0.022029897718332022, 'mean_word_length': 4.4139693356047704, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 7, 'https://': 14, 'lorem ipsum': 0, 'www.': 12, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 18, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1283805', 'n_tokens_mistral': 2173, 'n_tokens_neox': 2012, 'n_words': 645}