|
1 | 1 | ## **Current test status:** |
2 | 2 |
|
3 | | -**Test Suite** | **Status (master)** | **Status (develop)** |
4 | | -:-----------------------: | :-----------------: | :------------------: |
5 | | -**Linux/Python 2.7.12** | [,branch:(master)/statusIcon)](https://dev.aegresco.com/teamcity/viewType.html?buildTypeId=Csbuild_LinuxPython2&branch_Csbuild=master&guest=1) | [,branch:(develop)/statusIcon)](https://dev.aegresco.com/teamcity/viewType.html?buildTypeId=Csbuild_LinuxPython2&branch_Csbuild=develop&guest=1) |
6 | | -**Linux/Python 3.5.2** | [,branch:(master)/statusIcon)](https://dev.aegresco.com/teamcity/viewType.html?buildTypeId=Csbuild_LinuxPython3&branch_Csbuild=master&guest=1) | [,branch:(develop)/statusIcon)](https://dev.aegresco.com/teamcity/viewType.html?buildTypeId=Csbuild_LinuxPython3&branch_Csbuild=develop&guest=1) |
7 | | -**macOS/Python 2.7.12** | [,branch:(master)/statusIcon)](https://dev.aegresco.com/teamcity/viewType.html?buildTypeId=Csbuild_MacOSPython2&branch_Csbuild=master&guest=1) | [,branch:(develop)/statusIcon)](https://dev.aegresco.com/teamcity/viewType.html?buildTypeId=Csbuild_MacOSPython2&branch_Csbuild=develop&guest=1) |
8 | | -**macOS/Python 3.5.2** | [,branch:(master)/statusIcon)](https://dev.aegresco.com/teamcity/viewType.html?buildTypeId=Csbuild_MacOSPython3&branch_Csbuild=master&guest=1) | [,branch:(develop)/statusIcon)](https://dev.aegresco.com/teamcity/viewType.html?buildTypeId=Csbuild_MacOSPython3&branch_Csbuild=develop&guest=1) |
9 | | -**Windows/Python 2.7.12** | [,branch:(master)/statusIcon)](https://dev.aegresco.com/teamcity/viewType.html?buildTypeId=Csbuild_WindowsPython27&branch_Csbuild=master&guest=1) | [,branch:(develop)/statusIcon)](https://dev.aegresco.com/teamcity/viewType.html?buildTypeId=Csbuild_WindowsPython27&branch_Csbuild=develop&guest=1) |
10 | | -**Windows/Python 3.4.4** | [,branch:(master)/statusIcon)](https://dev.aegresco.com/teamcity/viewType.html?buildTypeId=Csbuild_WindowsPython34&branch_Csbuild=master&guest=1) | [,branch:(develop)/statusIcon)](https://dev.aegresco.com/teamcity/viewType.html?buildTypeId=Csbuild_WindowsPython34&branch_Csbuild=develop&guest=1) |
11 | | -**Windows/Python 3.5.3** | [,branch:(master)/statusIcon)](https://dev.aegresco.com/teamcity/viewType.html?buildTypeId=Csbuild_WindowsPython35&branch_Csbuild=master&guest=1) | [,branch:(develop)/statusIcon)](https://dev.aegresco.com/teamcity/viewType.html?buildTypeId=Csbuild_WindowsPython35&branch_Csbuild=develop&guest=1) |
12 | | -**Windows/Python 3.6.1** | [,branch:(master)/statusIcon)](https://dev.aegresco.com/teamcity/viewType.html?buildTypeId=Csbuild_WindowsPython36&branch_Csbuild=master&guest=1) | [,branch:(develop)/statusIcon)](https://dev.aegresco.com/teamcity/viewType.html?buildTypeId=Csbuild_WindowsPython36&branch_Csbuild=develop&guest=1) |
13 | | -**Windows/Python 3.7.0** | [,branch:(master)/statusIcon)](https://dev.aegresco.com/teamcity/viewType.html?buildTypeId=Csbuild_WindowsPython37&branch_Csbuild=master&guest=1) | [,branch:(develop)/statusIcon)](https://dev.aegresco.com/teamcity/viewType.html?buildTypeId=Csbuild_WindowsPython37&branch_Csbuild=develop&guest=1) |
14 | | - |
15 | | -<br><br> |
16 | | -CSBuild is a language-agnostic build system focused on maximizing developer iteration time and providing tools for enabling |
17 | | -developers to improve their build workflow. Currently, CSBuild is undergoing a complete rewrite to address some core architecture |
18 | | -issues with the original iteration. It gets closer every day, but hasn't quite reached feature parity with the original CSBuild. |
| 3 | +**Platform** | **Test Suite** | **Status (develop)** |
| 4 | +:----------- |:--------------- | :------------------: |
| 5 | +Linux | Python 2.7 | [,branch:(develop)/statusIcon)](https://dev.aegresco.com/teamcity/viewType.html?buildTypeId=Csbuild_LinuxPython2&branch_Csbuild=develop&guest=1) |
| 6 | +Linux | Python 3.6 | [,branch:(develop)/statusIcon)](https://dev.aegresco.com/teamcity/viewType.html?buildTypeId=Csbuild_LinuxPython3&branch_Csbuild=develop&guest=1) |
| 7 | +||| |
| 8 | +macOS | Python 2.7 | [,branch:(develop)/statusIcon)](https://dev.aegresco.com/teamcity/viewType.html?buildTypeId=Csbuild_MacOSPython2&branch_Csbuild=develop&guest=1) |
| 9 | +macOS | Python 3.8 | [,branch:(develop)/statusIcon)](https://dev.aegresco.com/teamcity/viewType.html?buildTypeId=Csbuild_MacOSPython3&branch_Csbuild=develop&guest=1) |
| 10 | +||| |
| 11 | +Windows | Python 2.7 | [,branch:(develop)/statusIcon)](https://dev.aegresco.com/teamcity/viewType.html?buildTypeId=Csbuild_WindowsPython27&branch_Csbuild=develop&guest=1) |
| 12 | +Windows | Python 3.8 | [,branch:(develop)/statusIcon)](https://dev.aegresco.com/teamcity/viewType.html?buildTypeId=Csbuild_WindowsPython38&branch_Csbuild=develop&guest=1) |
| 13 | + |
| 14 | +--- |
| 15 | + |
| 16 | +CSBuild is a language-agnostic build system focused on maximizing developer iteration time and providing tools for enabling developers to improve their build workflow. Currently, CSBuild is undergoing a complete rewrite to address some core architecture issues with the original iteration. It gets closer every day, but hasn't quite reached feature parity with the original CSBuild. |
19 | 17 |
|
20 | 18 | What it currently can do: |
21 | | -- Build basic C++ files for Windows and Linux systems |
22 | | -- Be extended with tools to work in any language (a new feature that old CSBuild did not support) |
23 | | -- Support macro processing in all strings (i.e., SetOutputDirectory("{toolchainName}/{architectureName}/{targetName}")) |
| 19 | +- Build basic C++, java, objective-c, and assembly files |
| 20 | +- Build on Windows, Mac, BSD, Linux, android, PS3, PS4, and PSVita systems (language support varies by system) |
| 21 | +- Be extended with tools to work in any language |
| 22 | +- Support macro processing in all strings (i.e., `csbuild.SetOutputDirectory("{toolchainName}/{architectureName}/{targetName}")`) |
| 23 | +- Generate project files for Visual Studio 2010, 2012, 2013, 2015, 2017, and 2019. |
| 24 | +- Dependency graph generation by running with --dg |
| 25 | + <img src="doc_img/depends.gv.png" alt="Dependency Graph" style="zoom:50%;" /> |
24 | 26 |
|
25 | 27 | What's still missing that exists in old CSBuild: |
26 | | -- OSX, Android, and iOS support |
27 | 28 | - "Chunking" - intelligently combining multiple translation units into one and breaking them back apart to improve build turn-around |
28 | | -- Solution generation for Visual Studio and QtCreator |
| 29 | +- Solution generation for QtCreator |
29 | 30 | - Build GUI showing the progress of individual files and projects as they're build |
30 | | -- Dependency graph generation |
31 | 31 | - Build profiler to analyze and identify headers and lines of code that are expensive to compile |
32 | | -- Full whitelisting and blacklisting support for adding and excluding files and directories to projects |
33 | 32 |
|
34 | | -The core architecture is much more stable and maintainable than old CSBuild's, and tools are easier to implement than |
35 | | -they were before. The new architecture also successfully decouples csbuild from the c++ language, allowing it to be |
36 | | -truly versatile and language-agnostic. The new csbuild also cuts down considerably on wasted time during initial startup. |
37 | | -Now that the majority of the core features have been implemented, we expect feature parity for the tools and target platforms |
38 | | -supported by old CSBuild to start coming online very quickly, shortly followed by solution generation, chunking, |
39 | | -and the gui tools. |
| 33 | +The core architecture is much more stable and maintainable than old CSBuild's, and tools are easier to implement than they were before. The new architecture also successfully decouples csbuild from the c++ language, allowing it to be truly versatile and language-agnostic. The new csbuild also cuts down considerably on wasted time during initial startup. Now that the majority of the core features have been implemented, we expect feature parity for the tools and target platforms supported by old CSBuild to start coming online very quickly, shortly followed by solution generation, chunking, and the gui tools. |
| 34 | + |
| 35 | +Documentation hasn't been created for the new version of csbuild yet; however, we have created a large suite of tests, so in the short term, a lot of information can be gleaned from looking at the make.py file in each test. |
40 | 36 |
|
41 | 37 | Code for old csbuild, for those interested in it, can be found here: https://github.com/SleepingCatGames/csbuild |
| 38 | + |
| 39 | +--- |
| 40 | + |
| 41 | +## Development Notes |
| 42 | + |
| 43 | +Frozen requirements files are provided for both Python 2 & 3. Currently, the only dependency is pylint which is only needed when running the pylint unit test. If using virtual Python environments for csbuild development, please keep in mind that the pylint test will fail on macOS under the Python 2 virtual environment. However, if you install pylint to your system-installed copy of Python 2.7 and run against that, the pylint unit test will pass. This issue does not seem to be present on Windows or Linux and all other unit tests are unaffected by the presence of a Python2 virtual environment on macOS. |
0 commit comments