riscv
/
OpenFPGA
mirror of https://github.com/lnis-uofu/OpenFPGA.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #725 from lnis-uofu/tangxifan-patch-2 

Update compile.rst to avoid confusion in https://github.com/lnis-uofu/OpenFPGA/issues/724
This commit is contained in:
tangxifan 2022-07-21 18:44:00 -07:00 committed by GitHub
parent 8dd94fb522 21a0415ff3
commit 8217f62472
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/source/tutorials/getting_started/compile.rst
View File

@ -30,12 +30,16 @@ In general, please follow the steps to compile
**Quick Compilation Verification**
.. note:: Ensure that you install python dependences in :ref:`tutorial_compile_dependencies`.
To quickly verify the tool is well compiled, users can run the following command from OpenFPGA root repository
.. code-block:: shell
python3 openfpga_flow/scripts/run_fpga_task.py compilation_verification --debug --show_thread_logs
.. _tutorial_compile_dependencies:
Dependencies
~~~~~~~~~~~~
Full list of dependencies can be found at install_dependencies_build_.
@ -50,8 +54,11 @@ In particular, OpenFPGA requires specific versions for the following dependencie
:python dependencies:
python packages are also required:
.. code-block::
python3 -m pip install -r requirements.txt
.. _install_dependencies_build: https://github.com/lnis-uofu/OpenFPGA/blob/master/.github/workflows/install_dependencies_build.sh