Building Renode from source¶
This document provides detailed information on how to prepare the build environment, and then build and test Renode itself.
Downloading the source code¶
Renode’s source code is available on GitHub:
git clone https://github.com/renode/renode.git
Submodules will be automatically initialised and downloaded during the build process, so you do not need to do it at this point.
Additional prerequisites (for Robot framework testing)¶
If you followed the instructions above, Python should be installed in your system.
pip package manager and some additional modules to enable writing and running test cases with the Robot framework:
python -m pip install -r tools/requirements.txt
On Windows, the building process described in this section can only be executed in a Cygwin shell.
To build Renode, run:
There are some optional flags you can use:
-c clean instead of building -d build in debug configuration -v verbose mode -p build binary packages (requires some additional dependencies)
You can also build
Renode.sln from your IDE (like MonoDevelop or Visual Studio), but the
build.sh script has to be run at least once.
The build script can create native packages only, i.e., you must run it on Windows to create an
.msi installer package, on Linux for
.pkg.tar.xz packages or on macOS for the
Depending on the system, there may be some prerequisites for building Renode packages.
To build binary packages, run:
The packages will have a version assigned to them, defined by the contents of the
You can also build nightly packages with:
This will append a date and a commit SHA to the output files.
Location of packages¶
After completing successfully, the script will print the location of the files created: