Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix typos in documentation. #1

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

The compilation flow consists of the following parts:

* **elastic-circuits**: A collection of LLVM passes which input a C/C++ program and transform its IR into a dataflow circuit. The output of this pass is a .DOT file which represents a netlist of dataflow components. The details of the .DOT dataflow description are given in *Documents/Dataflow.md*.
* **elastic-circuits**: A collection of LLVM passes which input a C/C++ program and transform its IR into a dataflow circuit. The output of this pass is a .DOT file which represents a netlist of dataflow components. The details of the .DOT dataflow description are given in *Documentation/Dataflow.md*.

* **Buffers**: Buffer placement for throughput and critical path optimization. Inputs the .DOT netlist from *elastic-circuits* and outputs a .DOT netlist with buffers placed and sized to maximize throughput under a given clock period constaint.

Expand All @@ -16,4 +16,4 @@ All folders contain README files with detailed instructions on installation and

### Simulation and Verification

Please refer to *Documents/ModelSim Simulation.md* on details about running the simulation and incorporating Xilinx computational units into the dataflow designs. The designs can be verified using the framework in the *hls_verifier* folder.
Please refer to *Documentation/ModelSim Simulation.md* on details about running the simulation and incorporating Xilinx computational units into the dataflow designs. The designs can be verified using the framework in the *hls_verifier* folder.