Skip to content

Commit 57149f8

Browse files
committed
Updated README.md
1 parent 80cfbce commit 57149f8

File tree

1 file changed

+9
-20
lines changed

1 file changed

+9
-20
lines changed

README.md

Lines changed: 9 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -14,33 +14,22 @@ With PyFPGA, you can create your own FPGA development workflow tailored to your
1414

1515
Some of its benefits are:
1616
* It provides a unified API between tools/devices.
17-
* It's **Version Control Systems** and **Continuous Integration friendly**.
17+
* It's **Version Control Systems** and **Continuous Integration** friendly.
1818
* It ensures reproducibility and repeatability.
1919
* It consumes fewer system resources than GUI-based workflows.
2020

2121
## Basic example
2222

2323
```py
24-
from fpga import Project
24+
from pyfpga import Vivado
2525

26-
# Specify the backend tool and an optional project name
27-
prj = Project('vivado', 'example')
28-
29-
# Set the device/part
26+
prj = Vivado('example')
3027
prj.set_part('xc7z010-1-clg400')
31-
32-
# Add HDL sources to the project
33-
prj.add_files('location1/*.v')
34-
prj.add_files('location2/top.v')
35-
36-
# Optionally add constraint files to the project
37-
prj.add_files('location3/example.xdc')
38-
39-
# Set the top-level unit name
28+
prj.add_vlog('location1/*.v')
29+
prj.add_vlog('location2/top.v')
30+
prj.add_constraint('location3/example.xdc')
4031
prj.set_top('Top')
41-
42-
# Generate the bitstream running the tool
43-
prj.generate()
32+
prj.make()
4433
```
4534

4635
The next steps are to read the [docs](https://pyfpga.github.io/pyfpga) or take a look at [examples](examples).
@@ -54,11 +43,11 @@ For a comprehensive list of supported tools, features and limitations, please re
5443

5544
> **NOTE:**
5645
> PyFPGA assumes that the underlying tools required for operation are ready to be executed from the running terminal.
57-
> This includes having the tools installed, properly configured, and licensed (when needed).
46+
> This includes having the tools installed, properly configured and licensed (when needed).
5847
5948
## Installation
6049

61-
PyFPGA requires Python>=3.7.
50+
PyFPGA requires Python>=3.8.
6251

6352
At the moment, it's only available as a git repository hosted on GitHub. It can be installed with pip:
6453

0 commit comments

Comments
 (0)