Skip to content
Snippets Groups Projects
Unverified Commit c352ba63 authored by Yaman Umuroglu's avatar Yaman Umuroglu Committed by GitHub
Browse files

[Docs] run-docker.sh needs bash

parent bda1ccb9
No related branches found
No related tags found
No related merge requests found
......@@ -13,7 +13,7 @@ The FINN compiler should not be thought of a single pushbutton tool that does ev
Requirements
============
* Ubuntu 18.04
* Ubuntu 18.04 with `bash` installed
* Docker
* A working Vivado 2019.1 installation
* A `VIVADO_PATH` environment variable pointing to the Vivado installation directory (e.g. the directory where settings64.sh is located)
......@@ -26,9 +26,11 @@ We use Docker extensively for developing and deploying FINN. If you are not fami
Getting an interactive shell for development or experimentation
***************************************************************
.. note:: **run-docker.sh requires bash to execute correctly.**
::
sh run_docker.sh
./run_docker.sh
Simply running sh run-docker.sh without any additional arguments will clone the dependency repos, create a Docker container and give you a terminal with you can use for development for experimentation.
If you want a new terminal on an already-running container, you can do this with `docker exec -it finn_dev_<username> bash`.
......@@ -41,7 +43,7 @@ Running the Jupyter notebooks
*****************************
::
sh run-docker.sh notebook
./run-docker.sh notebook
This will launch the `Jupyter notebook <https://jupyter.org/>`_ server inside a Docker container, and print a link on the terminal that you can open in your browser to run the FINN notebooks or create new ones.
.. note:: The link will look something like this (the token you get will be different):
......@@ -57,14 +59,14 @@ by:
::
sh run-docker.sh test
./run-docker.sh test
There is a quicker variant of the test suite that skips the tests marked as
requiring Vivado or as slow-running tests:
::
sh run-docker.sh quicktest
./run-docker.sh quicktest
If you want to run individual tests, you can do this *inside the Docker container
from the FINN root directory* as follows:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment