README.md

   1 # CRYENGINE
   2 This repository houses the source code for CRYENGINE.
   3
   4 Instructions on getting started with git can be found [here](http://docs.cryengine.com/display/CEPROG/Getting+Started+with+git), along with details on working with launcher projects and git source code.
   5
   6
   7 ## Building
   8 In order to compile, you will need to download some thirdparty SDKs. They can be downloaded by running the *download_sdks.py* script.
   9 Or on windows the *download_sdks.exe* can be used alternatively.
  10
  11 To compile the engine the provided WAF has to be used. See [here](http://docs.cryengine.com/display/CEPROG/Getting+Started+with+WAF) for more information.
  12
  13
  14 ## Branches
  15 Development takes place primarily in the "main" branch. The stabilisation branch is used for fixing bugs in the run-up to release, and the release branch provides stable snapshots of the engine.
  16
  17 To prepare for a major (feature) release, we integrate "main" into "stabilisation", and then continue fixing bugs in "stabilisation". To prepare for a minor (stability) release, individual changes from 'main are integrated directly into "stabilisation". In each case, when the release is deemed ready, "stabilisation" is integrated to "release".
  18
  19 Pull requests can only be accepted into the "pullrequests" branch.
  20
  21
  22 ## License
  23 The source code in this repository is governed by the CRYENGINE license agreement, which is contained in LICENSE.md, adjacent to this file.