Skip to content

Commit 05ee045

Browse files
Add doc
1 parent 53c3768 commit 05ee045

File tree

2 files changed

+13
-2
lines changed

2 files changed

+13
-2
lines changed

docs/source/Building fabric.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ completed.
1414

1515
#. Create a new project
1616

17-
.. prompt:: bash FABulous>
17+
.. prompt:: bash
1818

1919
FABulous -c demo
2020

docs/source/Usage.rst

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,17 +103,28 @@ Install FABulous with "editable" option:
103103
Building Fabric and Bitstream
104104
-----------------------------
105105

106+
We offer two ways to run the FABulous flow, either via the FABulous Shell or directly supplying the commands via the command line (similar to Vivado Batch mode).
107+
108+
To use the FABulous Shell, you can run the following command:
106109

107110
.. code-block:: console
108111
109112
(venv)$ FABulous -c <name_of_project>
110113
(venv)$ FABulous <name_of_project>
111114
112115
# inside the FABulous shell
113-
FABulous> load_fabric
114116
FABulous> run_FABulous_fabric
115117
FABulous> run_FABulous_bitstream user_design/sequential_16bit_en.v
116118
119+
120+
To run the FABulous flow directly from the command line, you can use the following commands:
121+
.. code-block:: console
122+
123+
(venv)$ FABulous -c <name_of_project>
124+
(venv)$ FABulous <name_of_project> -p "run_FABulous_fabric; run_FABulous_bitstream user_design/sequential_16bit_en.v"
125+
126+
127+
117128
.. note::
118129

119130
You will probably receive a warning for the FASM package like the following:

0 commit comments

Comments
 (0)