General Software Requirements

Unless otherwise specified the development environment of choice is Ubuntu 16.04.x LTS 64-bit. This can either be a Virtual Machine (VM) (e.g., VirtualBox) or a container (e.g., Windows WSL and/or Docker). As of this writing, the Ubuntu 16.04.x LTS VM ISO image is available at:

You will need to first perform an update to download the latest package lists from the repositories as shown below:

sudo apt-get update

After the update completes, you will need to install the following base packages required for development as shown below:

sudo apt-get install git gcc binutils autoconf
sudo apt-get install gcc-multilib
sudo apt-get install make unzip

Optionally, you will need to install Latex, Python and Sphinx in order to generate the documentation locally for überXMHF. More specifically, you will need to perform the following operations:

sudo apt install python3 python3-pip
sudo apt install texlive-latex-recommended texlive-fonts-recommended
sudo apt install texlive-latex-extra latexmk
     pip3 install -U 'Sphinx==2.2.0'

The documentation can be generated by the following commands:

cd docs
make clean
makd docs_html

Upon successful build, the documentation can be viewed in a browser by opening docs/_build/index.html