Building and Installing überSpark¶
Building überSpark Tools¶
You will need to build the überSpark toolchain before performing any other task. To achieve this, you need to issue the following command while in the top-level directory of the überSpark source-tree (the directory where the file RELEASE is located):
make
This will generate the required build truss to build the toolkit and documentation,
build the toolkit binaries, and additionally build the .html
version of the documentation.
Note
If you are re-building the tools after a prior build, you can perform a cleanup by
issuing the command: make clean
before issuing the
command make
as above.
Building überSpark Documentation in Other Formats¶
You can (optionally) build documentation in the .pdf
format.
To achieve this, you need to issue the following command while in the top-level directory of
the überSpark source-tree (the directory where the file RELEASE is located):
make docs_pdf
Installing überSpark¶
Upon a successful build, you will need to install the überSpark toolkit comprising various components such as binaries, system headers, hardware model etc.
You can do this using the following command, while in the top-level directory of the überSpark source-tree (the directory where the file RELEASE is located):
make install
Note
überSpark is installed at ~/uberspark
by default and
toolkit binaries are installed by default at: /usr/bin
system location.
Your user account must be part of the sudo’ers and you may need to enter your
sudo password during this step.
Note
If you are using Windows Subsystem for Linux (WSL) as your development environment,
you will need to issue make install ROOT_DIR=<NTFS volume path>
instead of
make install
as above. For example,
make install ROOT_DIR=/c/workspace/uberspark
; where /c/workspace/uberspark
is
where you would like überSpark to be installed. This is due to the fact that
docker is unable to mount host folders that are part of the WSL Linux filesystem (e.g., ~/
)
under Windows.