Contributor Guide

Building

To build Cesium, install .NET 6 SDK or later.

Want to add new tests to Cesium? Read a separate document on tests.

There are two kinds of tests in Cesium: unit tests and integration tests.

Run the unit tests using this shell command:

$ dotnet test

Run the integration tests using this shell command (PowerShell is required):

$ pwsh -c ./Cesium.IntegrationTests/Run-Tests.ps1 -NoBuild

(don't pass -NoBuild if you want to automatically rebuild the compiler before running the integration tests)

If you debug integration tests and want to run just a single test, use this shell command:

pwsh -c ./Cesium.IntegrationTests/Run-Tests.ps1 -TestCaseName quoted_include_fallback.c

where quoted_include_fallback.c is path within Cesium.IntegrationTests folder.

For producing standalone compiler executable run

dotnet publish Cesium.Compiler/Cesium.Compiler.csproj -r win-x64 --self-contained

Then navigate to Cesium.Compiler\bin\Debug\net6.0\win-x64\publish\ and that's your Cesium.