You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/basic.rst
+24-11Lines changed: 24 additions & 11 deletions
Original file line number
Diff line number
Diff line change
@@ -4,15 +4,17 @@ Basic usage
4
4
Project Configuration
5
5
---------------------
6
6
7
-
The first steps involve importing the necessary module to support the desired tool and instantiating the corresponding *class*:
7
+
The first steps involve importing the necessary module to support the desired tool and instantiating the corresponding ``class``:
8
8
9
9
.. code-block:: python
10
10
11
11
from pyfpga.vivado import Vivado
12
12
13
13
prj = Vivado('PRJNAME', odir='OUTDIR')
14
14
15
-
In the example, we are using Vivado, specifying the optional parameter *project name* (*tool name* if omitted) and *output directory* (*results* by default).
15
+
In the example, we are using Vivado, specifying the optional parameters
16
+
``project name`` (``tool name`` if omitted) and ``output directory``
17
+
(``results`` by default).
16
18
17
19
Next step is to specify the target FPGA device:
18
20
@@ -32,9 +34,8 @@ HDL source files are added using one of the following methods:
32
34
prj.add_vlog('PATH_TO_FILES_GLOB_COMPATIBLE')
33
35
prj.add_slog('PATH_TO_FILES_GLOB_COMPATIBLE')
34
36
35
-
In these methods, you provide a path to the files. The path can include wildcards (like `*.vhdl`), allowing you to match multiple files at once.
36
-
37
-
For `add_vhdl`, you can also optionally specify a library name where the files will be included.
37
+
In these methods, you provide a path to the files. The path can include wildcards (like ``*.vhdl``), allowing you to match multiple files at once.
38
+
In case of ``add_vhdl``, you can also optionally specify a library name where the files will be included.
38
39
39
40
.. note::
40
41
@@ -43,6 +44,15 @@ For `add_vhdl`, you can also optionally specify a library name where the files w
0 commit comments