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

Update compile.rst 

update grammar
This commit is contained in:
bbleaptrot 2021-06-14 14:51:19 -06:00 committed by GitHub
parent 1a2ced678e
commit 5e8b5d641f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -24,13 +24,13 @@ In general, please follow the steps to compile
.. note:: cmake3.12+ is recommended to compile OpenFPGA with GUI
.. note:: recommand to use ``make -j`` to accelerate the compilation
.. note:: recommend using ``make -j`` to accelerate the compilation
.. note:: VPR's GUI requires gtk-3, and can be enabled with ``cmake .. -DVPR_USE_EZGL=on``
**Quick Compilation Verification**
To quickly verify the tool is well compiled, user can run the following command from OpenFPGA root repository
To quickly verify the tool is well compiled, users can run the following command from OpenFPGA root repository
.. code-block:: shell
@ -38,7 +38,7 @@ To quickly verify the tool is well compiled, user can run the following command
Dependencies
~~~~~~~~~~~~
Full list of dependencies can be found at install_dependencies_build_
Full list of dependencies can be found at install_dependencies_build_.
In particular, OpenFPGA requires specific versions for the following dependencies:
:cmake:
@ -53,8 +53,8 @@ In particular, OpenFPGA requires specific versions for the following dependencie
Running with the docker image
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Users can skip the traditional installation process by using Dockerized version
of the OpenFPGA tool. OpenFPGA project maintains the docker image/Github package of
Users can skip the traditional installation process by using the Dockerized version
of the OpenFPGA tool. The OpenFPGA project maintains the docker image/Github package of
the latest stable version of OpenFPGA in the following repository
`openfpga-master <https://github.com/orgs/lnis-uofu/packages/container/package/openfpga-master>`_.
This image contains precompiled OpenFPGA binaries with all prerequisites installed.
@ -76,4 +76,4 @@ This image contains precompiled OpenFPGA binaries with all prerequisites install
.. note::
While running local task using docker, make sure all the additional files
are maintained in the task_directory and reference using variable ${TASK_DIR}
are maintained in the task_directory and reference using variable ${TASK_DIR}