Skip to content

Commit a93dc28

Browse files
committed
Fix typo in Quick Start
1 parent f13f87b commit a93dc28

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

doc/src/quickstart/index.rst

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,22 @@
22
VTR Quick Start
33
###############
44

5-
This is a quick introduction to VTR which covers how to run VTR and some if its associated tools (:ref:`VPR`, :ref:`odin_ii`, :ref:`ABC`).
5+
This is a quick introduction to VTR which covers how to run VTR and some of its associated tools (:ref:`VPR`, :ref:`odin_ii`, :ref:`ABC`).
66

77
Setting Up VTR
88
==============
99

1010
Download VTR
1111
------------
1212

13-
The first step is to `download VTR <https://verilogtorouting.org/download/>`_ and extract VTR on your local machine.
13+
The first step is to `download VTR <https://verilogtorouting.org/download/>`_ and extract it on your local machine.
1414

1515
.. note:: Developers planning to modify VTR should clone the `VTR git repository <https://github.com/verilog-to-routing/vtr-verilog-to-routing/>`_.
1616

1717

1818
Environment Setup
1919
-----------------
20-
If you cloned the repository you will need to set up the git submodules (if you downloaded and extracted a release, you can skip this step):
20+
If you cloned the repository, you will need to set up the git submodules (if you downloaded and extracted a release, you can skip this step):
2121

2222
.. code-block:: bash
2323
@@ -77,12 +77,12 @@ For more details on building VTR on various operating systems/platforms see :doc
7777
Running VPR
7878
===========
7979

80-
Lets now try taking a simple pre-synthesized circuit (consisting of LUTs and Flip-Flops) and use the VPR tool to implement it on a specific FPGA architecture.
80+
Let's now try taking a simple pre-synthesized circuit (consisting of LUTs and Flip-Flops) and use the VPR tool to implement it on a specific FPGA architecture.
8181

8282
Running VPR on a Pre-Synthesized Circuit
8383
----------------------------------------
8484

85-
First, lets make a directory in our home directory where we can work:
85+
First, let's make a directory in our home directory where we can work:
8686

8787
.. code-block:: bash
8888
@@ -211,13 +211,13 @@ Running the VTR Flow
211211
In the previous section we have implemented a pre-synthesized circuit onto a pre-existing FPGA architecture using VPR, and visualized the result.
212212
We now turn to how we can implement *our own circuit* on a pre-existing FPGA architecture.
213213

214-
To do this we begin by describing a circuit behaviourly using the Verilog Hardware Description Language (HDL).
214+
To do this, we begin by describing a circuit behaviourally using the Verilog Hardware Description Language (HDL).
215215
This allows us to quickly and consisely define the circuit's behaviour.
216216
We will then use the VTR Flow to synthesize the behavioural Verilog description it into a circuit netlist, and implement it onto an FPGA.
217217

218218
Example Circuit
219219
---------------
220-
We will use the following simple example circuit, which causes it's output to toggle on and off:
220+
We will use the following simple example circuit, which causes its output to toggle on and off:
221221

222222
.. literalinclude:: blink.v
223223
:language: verilog
@@ -230,7 +230,7 @@ If the count is below ``16`` it drives the output (``o_led``) high, otherwise it
230230

231231
Manually Running the VTR Flow
232232
-----------------------------
233-
Lets start by making a fresh directory for us to work in:
233+
Let's start by making a fresh directory for us to work in:
234234

235235
.. code-block:: bash
236236
@@ -241,15 +241,15 @@ Next we need to run the three main sets of tools:
241241

242242
* :ref:`odin_ii` performs 'synthesis' which converts our behavioural Verilog (``.v`` file) into a circuit netlist (``.blif`` file) consisting of logic equations and FPGA architecture primitives (Flip-Flops, adders etc.),
243243
* :ref:`ABC` performs 'logic optimization' which simplifies the circuit logic, and 'technology mapping' which converts logic equations into the Look-Up-Tables (LUTs) available on an FPGA, and
244-
* :ref:`VPR` which performs packing, placement and routing of the circuit to implement it on the targetted FPGA architecture.
244+
* :ref:`VPR` which performs packing, placement and routing of the circuit to implement it on the targeted FPGA architecture.
245245

246246
.. _synthesizing_with_odin_ii:
247247
Synthesizing with ODIN II
248248
~~~~~~~~~~~~~~~~~~~~~~~~~
249249

250250
First we'll run ODIN II on our Verilog file to synthesize it into a circuit netlist, providing the options:
251251

252-
* ``-a $VTR_ROOT/vtr_flow/arch/timing/EArch.xml`` which specifies what FPGA architecture we are targetting,
252+
* ``-a $VTR_ROOT/vtr_flow/arch/timing/EArch.xml`` which specifies what FPGA architecture we are targeting,
253253
* ``-V $VTR_ROOT/doc/src/quickstart/blink.v`` which specifies the verilog file we want to synthesize, and
254254
* ``-o blink.odin.blif`` which specifies the name of the generated ``.blif`` circuit netlist.
255255

@@ -400,7 +400,7 @@ Automatically Running the VTR Flow
400400
Running each stage of the flow manually is time consuming (and potentially error prone).
401401
For convenience, VTR provides a script (:ref:`run_vtr_flow`) which automates this process.
402402

403-
First, make sure you sure you have activated the Python virtual environment created at the beginning of this tutorial:
403+
First, make sure you have activated the Python virtual environment created at the beginning of this tutorial:
404404

405405
.. code-block:: bash
406406

0 commit comments

Comments
 (0)