Building and Installing überSpark

Building überSpark Tools

You will need to build the überSpark toolchain before any other tasks. For this purpose, While in the top-level directory of the überSpark repository, switch directory to überSpark sources:

cd src

Then prepare for the build as below:

./bsconfigure.sh
./configure

And finally, build the toolchain:

make

Building überSpark Documentation

You can (optionally) build this documentation locally. For this purpose, While in the top-level directory of the überSpark repository, switch directory to überSpark sources:

cd src

Now, build the .pdf documentation using the following command:

make docs_pdf

Upon a successful build, the generated .pdf of the documentation can be found at docs/_build/uberspark_documentation.pdf, relative to the top-level directory of the überSpark repository.

Note

For make docs_pdf to work successfuly, you will need to install the packages required for generating documents locally as described in Packages for Generating Documentation.

You can also build the .html version of the document using the following command:

make docs_html

In this case, upon a successful build, the generated .html documentation can be found at docs/_build/index.html, relative to the top-level directory of the überSpark repository.

Installing überSpark

Upon a successful build, you will need to install the überSpark toolchain, system headers and hardware-model related files. You can do this using the following command (while in the same directory of überSpark sources src/):

sudo make install