Skip to content

Latest commit

 

History

History
119 lines (82 loc) · 3.86 KB

README.md

File metadata and controls

119 lines (82 loc) · 3.86 KB
Raw

Building Mono

Build Requirements

Windows Linux macOS FreeBSD
Requirements Requirements Requirements

Before proceeding further, please click on the link above that matches your machine and ensure you have installed all the prerequisites for the build to work.

Concept

To build a complete runtime environment, you need to build both the Mono runtime and libraries. At the repo root, simply execute:

./build.sh mono+libs

or on Windows,

build.cmd mono+libs

Note that the debug configuration is the default option. It generates a 'debug' output and that includes asserts, fewer code optimizations, and is easier for debugging. If you want to make performance measurements, or just want tests to execute more quickly, you can also build the 'release' version which does not have these checks by adding the flag -configuration release (or -c release).

Once you've built the complete runtime and assuming you want to work with just mono, you want to use the following command:

./build.sh mono

or on Windows,

build.cmd mono

When the build completes, product binaries will be dropped in the artifacts\bin\mono\<OS>.<arch>.<flavor> folder.

If you need to run library tests or run HelloWorld sample with your change to mono, you want to build mono with this command instead:

./build.sh mono+libs.pretest

or on Windows,

build.cmd mono+libs.pretest

If you want to skip restoring nuget packages, when only making change to mono, you want to use this command:

./build.sh mono --build

or on Windows,

build.cmd mono --build

Useful Build Arguments

Here are a list of build arguments that may be of use:

/p:MonoEnableLlvm=true - Builds mono w/ LLVM

/p:MonoEnableLlvm=true /p:MonoLLVMDir=path/to/llvm - Builds mono w/ LLVM from a custom path

/p:MonoEnableLlvm=true /p:MonoLLVMDir=path/to/llvm /p:MonoLLVMUseCxx11Abi=true - Builds mono w/ LLVM from a custom path (and that LLVM was built with C++11 ABI)

For build.sh

/p:DisableCrossgen=true - Skips building the installer if you don't need it (builds faster)

/p:KeepNativeSymbols=true - Keep the symbols in the binary instead of stripping them out to a separate file. This helps with debugging Mono with lldb.

The build has a number of options that you can learn about using build -?.

WebAssembly

See the instructions for Building WebAssembly.

Android

See the instructions for Testing Android

iOS

See the instructions for Testing iOS

Packages

To generate nuget packages:

./build.sh packs -runtimeFlavor mono (with optional release configuration)

or on Windows,

build.cmd packs -runtimeFlavor mono (with optional release configuration)

The following packages will be created under artifacts\packages\<configuration>\Shipping:

  • Microsoft.NETCore.Runtime.Mono.<version>-dev.<number>.1.nupkg
  • runtime.<OS>.Microsoft.NETCore.Runtime.Mono.<version>-dev.<number>.1.nupkg
  • transport.Microsoft.NETCore.Runtime.Mono.<version>-dev.<number>.1.nupkg
  • transport.runtime.<OS>.Microsoft.NETCore.Runtime.Mono.<version>-dev.<number>.1.nupkg

To get started with "Hello World"

Try the sample at src/mono/sample/HelloWorld. To run this sample, from the above folder

make run

Important Notes

Test binaries are not yet available for mono.

The build places logs in artifacts\log and these are useful when the build fails.

The build places all of its output in the artifacts\obj\mono directory, so if you remove that directory you can force a full rebuild.