[chore] Add readme with building instructions

This commit is contained in:
Peter Sykora 2019-01-13 15:35:55 +01:00
parent e5e1886bc7
commit 9e14321827

47
README.md Normal file
View File

@ -0,0 +1,47 @@
Automatic updater, Licensing client and Content server for Catalogue of Currencies
## Prequisites
Before building the solution please make sure to install following:
1. Python 3.x - (https://www.python.org/)
2. Conan - (https://conan.io/)
Installation:
```
pip install conan
```
3. Visual Studio 2017
Necessary components:
* Windows 8.1 SDK
* Visual C++ tools for CMake
* Windows Universal CRT SDK
## Install project related dependencies
a. Clone *libLicenseClient* dependency to one level up
```
cd ..
git clone git@31.31.72.216:/srv/git/libLicenseClient.git
```
b. Run `workspace.bat` whenever that file or any *conanfile.txt* in subprojects is updated
## Building
To build open the *CCEngine.sln* file in Visual studio and *Build* -> *Build Solution*
## Deployment
To make deployment package you will have to build Release version of the solution and collect the following files:
* `CCEngine\build\Release\*`
* `Release\CCEngine.exe`
* `Release\CCEngineLoader.exe`
* VS runtime: `concrt140.dll`, `msvcp140.dll`, `vcruntime140.dll`