Skip to content

Commit 8181d67

Browse files
committed
Changed text format in README.
1 parent 437a513 commit 8181d67

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Simple UART for FPGA is UART (Universal Asynchronous Receiver & Transmitter) con
66

77
The UART controller was simulated and tested in hardware.
88

9-
# Inputs and outputs ports:
9+
## Inputs and outputs ports:
1010

1111
```
1212
-- CLOCK AND RESET
@@ -25,7 +25,7 @@ DOUT_VLD : out std_logic; -- when DOUT_VLD = 1, output data (DOUT) are valid
2525
FRAME_ERROR : out std_logic -- when FRAME_ERROR = 1, stop bit was invalid (is assert only for one clock cycle)
2626
```
2727

28-
# Generics:
28+
## Generics:
2929

3030
```
3131
CLK_FREQ : integer := 50e6; -- system clock frequency in Hz
@@ -34,7 +34,7 @@ PARITY_BIT : string := "none"; -- type of parity: "none", "even", "odd", "ma
3434
USE_DEBOUNCER : boolean := True -- enable/disable debouncer
3535
```
3636

37-
# Table of resource usage summary:
37+
## Table of resource usage summary:
3838

3939
Use debouncer | Parity type | LE (LUT+FF) | LUT | FF | BRAM | Fmax
4040
:---:|:---:|:---:|:---:|:---:|:---:|:---:
@@ -47,19 +47,19 @@ False | mark/space | 74 | 61 | 52 | 0 | 186.2 MHz
4747

4848
*Implementation was performed using Quartus Prime Lite Edition 17.0.0 for FPGA Altera Cyclone IV E EP4CE6E22C8. Setting of some generics: BAUD_RATE = 115200, CLK_FREQ = 50e6.*
4949

50-
# Simulation:
50+
## Simulation:
5151

5252
A basic simulation is prepared in the repository. You can use the prepared TCL script to run simulation in ModelSim.
5353

5454
```
5555
vsim -do sim/sim.tcl
5656
```
5757

58-
# UART LOOPBACK EXAMPLE
58+
## UART loopback example:
5959

6060
The UART loopback example design is for testing data transfer between FPGA and PC.
6161
I use it on my cheap FPGA board ([EP4CE6 Starter Board](http://www.ebay.com/itm/111975895262) with Altera FPGA Cyclone IV EP4CE6E22C8) together with external USB to UART Bridge.
6262

63-
# License:
63+
## License:
6464

6565
This UART controller is available under the MIT license (MIT). Please read [LICENSE file](LICENSE).

0 commit comments

Comments
 (0)