Skip to content

Commit d262582

Browse files
authored
Update README.md
1 parent 2845a2a commit d262582

File tree

1 file changed

+20
-10
lines changed

1 file changed

+20
-10
lines changed

README.md

+20-10
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,19 @@
1-
basic_verilog
2-
=============
1+
Must-have verilog systemverilog modules
2+
---------------------------------------
33

4-
Some basic must-have verilog modules
5-
------------------------------------
4+
Hello! This is a collection of verilog systemverilog synthesizable modules.<br>
5+
All the code is highly reusable across typical FPGA projects and mainstream FPGA vendors.<br>
6+
Please feel free to contact me in case you found any code issues.<br>
7+
Also, give me a pleasure, tell me if the code has got succesfully implemented in your hobby, scientific or industrial projects!<br>
68

7-
(licensed under CC BY-SA 4_0)
8-
9-
Author: Konstantin Pavlov, [email protected]
9+
Konstantin Pavlov, [email protected]
1010

11-
CONTENTS:
12-
---------
11+
The code is licensed under CC BY-SA 4_0.<br>
12+
You can remix, transform, and build upon the material for any purpose, even commercially<br>
13+
You must provide the name of the creator and distribute your contributions under the same license as the original<br>
14+
15+
Directories description:
16+
-----------------------
1317

1418
| DIRECTORY | DESCRIPTION |
1519
|-----------|-------------|
@@ -20,6 +24,9 @@ CONTENTS:
2024
| benchmark_projects/ | compilation time benchmarks for a dosen of FPGA types |
2125
| scripts/ | useful TCL scripts |
2226

27+
Scripts description:
28+
--------------------
29+
2330
| SCRIPT | DESCRIPTION |
2431
|--------|-------------|
2532
| scripts/allow_undefined_ports.tcl | allows generation of test projects with undefined pins for Vivado IDE |
@@ -36,6 +43,9 @@ CONTENTS:
3643
| scripts/set_project_directory.tcl | changes current directory to match project directory in Vivado IDE |
3744
| scripts/write_avalon_mm_from_file.tcl | writing bulk binary data from binary file to Avalon-MM through JTAG-to-Avalon-MM bridge IP |
3845

46+
Modules description:
47+
--------------------
48+
3949
| MODULE | DESCRIPTION |
4050
|--------|-------------|
4151
| ActionBurst.v | multichannel one-shot triggering module |
@@ -49,7 +59,7 @@ CONTENTS:
4959
| dynamic_delay.sv | dynamic delay for arbitrary input signal |
5060
| edge_detect.sv | combinational edge detector, gives one-tick pulses on every signal edge |
5161
| encoder.v | digital encoder input logic module |
52-
| fifo.sv | single-clock FIFO buffer (queue) implementation |
62+
| fifo_single_clock_reg_*.sv | single-clock FIFO buffer (queue) implementation |
5363
| gray2bin.sv | combinational binary to Gray code converter |
5464
| leave_one_hot.sv | combinational module that leaves only lowest hot bit |
5565
| lifo.sv | single-clock LIFO buffer (stack) implementation |

0 commit comments

Comments
 (0)