Skip to content

Commit 24b8cde

Browse files
committed
Update docs to fix typos
This fixes some typos on docs
1 parent b26989d commit 24b8cde

6 files changed

+10
-14
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ So far, we have tested CYNQ on:
9999
Cite Us:
100100
101101
```
102-
@misc{blabla,
102+
@misc{cynq,
103103
author = {{León-vega, Luis G.
104104
AND Ávila-Torres, Diego
105105
AND Castro-Godínez, Jorge

docs/About.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,8 @@ This project is completely Open Source thanks to:
1212
* Ministero dell'Università e della Ricerca
1313
* University of Trieste
1414
* Costa Rica Institute of Technology
15-
* eXact Lab
16-
* RidgeRun LLC
1715

18-
Our goal is to keep it Open Source, accesible and powerful. Collaboration and improvements are very welcome.
16+
Our goal is to keep it Open Source, accessible and powerful. Collaboration and improvements are very welcome.
1917

2018
The current maintainers are:
2119

docs/Foundations.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ To develop on Xilinx FPGAs, there are a couple of workflows:
77
1. Legacy HLS -> Vivado workflow
88
2. Vitis Kernel workflow (newest)
99

10-
The first workflow is general and works in most of the use cases, independently if the FPGA is intended for Cloud, Edge or instrumental use (like Spartan and Artix). The key artifact is a bitstream (.bit) used for configuring the FPGA, requiring only Vitis/Vivado HLS and Vivado Design Suite.
10+
The first workflow is general and works in most use cases, independently of the FPGA is intended for Cloud, Edge or instrumental use (like Spartan and Artix). The key artifact is a bitstream (.bit) used for configuring the FPGA, requiring only Vitis/Vivado HLS and Vivado Design Suite.
1111

12-
The second workflow is most specific for acceleration. It is used in modern MPSoCs and cloud-grade FPGAs. The key artifact is a binary (.xclbin) that is produced by a long chain of: Vitis HLS, Vivado Design Suite, Petalinux and Vitis. As you may notice, it's more tedious and require more tooling, consuming more storage in the development machine.
12+
The second workflow is most specific for acceleration. It is used in modern MPSoCs and cloud-grade FPGAs. The key artifact is a binary (.xclbin) that is produced by a long chain of: Vitis HLS, Vivado Design Suite, Petalinux and Vitis. As you may notice, it's more tedious and requires more tooling, consuming more storage in the development machine.
1313

1414
PYNQ, particularly, has been characterised by its simplicity, only requiring the bitstream to work. It has also proved to be effective in a wide variety of boards, namely ZYNQ MPSoC and Alveo cards. In contrast, the new workflow requires more expertise in the tooling but produces better applications in terms of performance. However, the former one sacrifices a lot of the simplicity.
1515

@@ -29,7 +29,7 @@ Within our plans, we want to:
2929
* Complete the support for XRT interoperability.
3030
* Provide a library with math kernels.
3131

32-
This first release is a huge advance towards simplicity and we expect that many users look at CYNQ as the chance that they were waiting for to get started into the FPGA world, as seen in PYNQ.
32+
This first release is a huge advance towards simplicity and we expect that many users look at CYNQ as the chance that they were waiting for to get started in the FPGA world, as seen in PYNQ.
3333

3434
## How does CYNQ work?
3535

docs/html/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ <h2>Links &amp; References:</h2>
131131
<li>Github: <a href="https://github.com/ECASLab/cynq">https://github.com/ECASLab/cynq</a></li>
132132
</ul>
133133
<p>Cite Us:</p>
134-
<div class="fragment"><div class="line">@misc{blabla,</div><div class="line"> author = {{León-vega, Luis G.</div><div class="line"> AND Ávila-Torres, Diego</div><div class="line"> AND Castro-Godínez, Jorge</div><div class="line"> }},</div><div class="line"> title = {{CYNQ (v0.1)}},</div><div class="line"> year = {2023},</div><div class="line"> url = {https://github.com/ECASLab/cynq},</div><div class="line">} </div></div><!-- fragment --> </div></div><!-- contents -->
134+
<div class="fragment"><div class="line">@misc{cynq,</div><div class="line"> author = {{León-vega, Luis G.</div><div class="line"> AND Ávila-Torres, Diego</div><div class="line"> AND Castro-Godínez, Jorge</div><div class="line"> }},</div><div class="line"> title = {{CYNQ (v0.1)}},</div><div class="line"> year = {2023},</div><div class="line"> url = {https://github.com/ECASLab/cynq},</div><div class="line">} </div></div><!-- fragment --> </div></div><!-- contents -->
135135
</div><!-- doc-content -->
136136
<!-- start footer part -->
137137
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->

docs/html/md__media_lleon95_data_Personal_cynq_docs_About.html

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -107,10 +107,8 @@
107107
<li>Ministero dell'Università e della Ricerca</li>
108108
<li>University of Trieste</li>
109109
<li>Costa Rica Institute of Technology</li>
110-
<li>eXact Lab</li>
111-
<li>RidgeRun LLC</li>
112110
</ul>
113-
<p>Our goal is to keep it Open Source, accesible and powerful. Collaboration and improvements are very welcome.</p>
111+
<p>Our goal is to keep it Open Source, accessible and powerful. Collaboration and improvements are very welcome.</p>
114112
<p>The current maintainers are:</p>
115113
<ul>
116114
<li>Luis G. Leon Vega <a href="#" onclick="location.href='mai'+'lto:'+'lui'+'s.'+'leo'+'n@'+'iee'+'e.'+'org'; return false;">luis.<span style="display: none;">.nosp@m.</span>leon<span style="display: none;">.nosp@m.</span>@ieee<span style="display: none;">.nosp@m.</span>.org</a></li>

docs/html/md__media_lleon95_data_Personal_cynq_docs_Foundations.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -101,8 +101,8 @@
101101
<li>Legacy HLS -&gt; Vivado workflow</li>
102102
<li>Vitis Kernel workflow (newest)</li>
103103
</ol>
104-
<p>The first workflow is general and works in most of the use cases, independently if the FPGA is intended for Cloud, Edge or instrumental use (like Spartan and Artix). The key artifact is a bitstream (.bit) used for configuring the FPGA, requiring only Vitis/Vivado HLS and Vivado Design Suite.</p>
105-
<p>The second workflow is most specific for acceleration. It is used in modern MPSoCs and cloud-grade FPGAs. The key artifact is a binary (.xclbin) that is produced by a long chain of: Vitis HLS, Vivado Design Suite, Petalinux and Vitis. As you may notice, it's more tedious and require more tooling, consuming more storage in the development machine.</p>
104+
<p>The first workflow is general and works in most use cases, independently of the FPGA is intended for Cloud, Edge or instrumental use (like Spartan and Artix). The key artifact is a bitstream (.bit) used for configuring the FPGA, requiring only Vitis/Vivado HLS and Vivado Design Suite.</p>
105+
<p>The second workflow is most specific for acceleration. It is used in modern MPSoCs and cloud-grade FPGAs. The key artifact is a binary (.xclbin) that is produced by a long chain of: Vitis HLS, Vivado Design Suite, Petalinux and Vitis. As you may notice, it's more tedious and requires more tooling, consuming more storage in the development machine.</p>
106106
<p>PYNQ, particularly, has been characterised by its simplicity, only requiring the bitstream to work. It has also proved to be effective in a wide variety of boards, namely ZYNQ MPSoC and Alveo cards. In contrast, the new workflow requires more expertise in the tooling but produces better applications in terms of performance. However, the former one sacrifices a lot of the simplicity.</p>
107107
<h2>Our Proposal</h2>
108108
<p>Looking at that, we want to propose a new library based on PYNQ to allow users to code efficient C++ application while keeping the simplicity of PYNQ, allowing even more features like:</p>
@@ -119,7 +119,7 @@ <h2>Our Proposal</h2>
119119
<li>Complete the support for XRT interoperability.</li>
120120
<li>Provide a library with math kernels.</li>
121121
</ul>
122-
<p>This first release is a huge advance towards simplicity and we expect that many users look at CYNQ as the chance that they were waiting for to get started into the FPGA world, as seen in PYNQ.</p>
122+
<p>This first release is a huge advance towards simplicity and we expect that many users look at CYNQ as the chance that they were waiting for to get started in the FPGA world, as seen in PYNQ.</p>
123123
<h2>How does CYNQ work?</h2>
124124
<p>An application is mounted on top of an abstract interface to make the API feel agnostic. In this case, CYNQ is composed of four major components:</p>
125125
<ul>

0 commit comments

Comments
 (0)