Skip to content

Commit 6375546

Browse files
committed
README.md and pages.md are updated
1 parent 24236cd commit 6375546

File tree

2 files changed

+15
-18
lines changed

2 files changed

+15
-18
lines changed

README.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
Pyverilog
22
==============================
3+
34
Python-based Hardware Design Processing Toolkit for Verilog HDL
45

56
Copyright (C) 2013, Shinya Takamaeda-Yamazaki
@@ -9,18 +10,17 @@ E-mail: shinya\_at\_is.naist.jp
910

1011
License
1112
==============================
13+
1214
Apache License 2.0
1315
(http://www.apache.org/licenses/LICENSE-2.0)
1416

15-
This software package includes PLY-3.4 in "vparser/ply".
16-
The license of PLY is BSD.
17+
This software package includes PLY-3.4 in "vparser/ply". The license of PLY is BSD.
1718

1819

1920
What's Pyverilog?
2021
==============================
2122

22-
Pyverilog is open-source hardware design processing toolkit for Verilog HDL.
23-
All source codes are written in Python.
23+
Pyverilog is an open-source hardware design processing toolkit for Verilog HDL. All source codes are written in Python.
2424

2525
Pyverilog includes **(1) code parser, (2) dataflow analyzer, (3) control-flow analyzer and (4) code generator**.
2626
You can create your own design analyzer, code translator and code generator of Verilog HDL based on this toolkit.
@@ -31,14 +31,14 @@ Software Requirements
3131

3232
* Python (2.7, 3.3 or later)
3333
* Icarus Verilog (0.9.6 or later)
34-
- vparser.preprocessor.py uses 'iverilog -E' command instead of the preprocessor.
34+
- pyverilog.vparser.preprocessor.py uses 'iverilog -E' command as the preprocessor.
3535
- 'apt-get install iverilog'
3636
* Graphviz and Pygraphviz (Python3 does not support Pygraphviz)
37-
- graphgen.py in dataflow and controlflow.py in controlflow (without --nograph option) use Pygraphviz with Python 2.7.
38-
- If you do not use graphgen.py and controlflow.py (without --nograph) option, Python 3 is OK.
37+
- pyverilog.dataflow.graphgen and pyverilog.controlflow.controlflow (without --nograph option) use Pygraphviz (on Python 2.7).
38+
- If you do not use graphgen and controlflow (without --nograph) option, Python 3.x is fine.
3939
* Jinja2 (2.7 or later)
4040
- ast\_code\_generator requires jinja2 module.
41-
- 'pip3 install jinja2'
41+
- 'pip3 install jinja2' (for Python 3.x) or 'pip install jinja2' (for Python 2.7)
4242

4343

4444
Tools
@@ -328,9 +328,8 @@ Related Project and Site
328328
==============================
329329

330330
[PyCoRAM](http://shtaxxx.github.io/PyCoRAM/)
331-
- Python-based Implementation of CoRAM Memory Architecture for AXI4 Interconnection on FPGAs
331+
- Python-based Portable IP-core Synthesis Framework for FPGA-based Computing
332332

333333
[shtaxxx.hatenablog.com](http://shtaxxx.hatenablog.com/entry/2014/01/01/045856)
334334
- Blog entry for introduction and examples of Pyverilog (in Japansese)
335335

336-

pages.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
What's Pyverilog?
22
==============================
33

4-
Pyverilog is open-source hardware design processing toolkit for Verilog HDL.
5-
All source codes are written in Python.
4+
Pyverilog is an open-source hardware design processing toolkit for Verilog HDL. All source codes are written in Python.
65

76
Pyverilog includes **(1) code parser, (2) dataflow analyzer, (3) control-flow analyzer and (4) code generator**.
87
You can create your own design analyzer, code translator and code generator of Verilog HDL based on this toolkit.
@@ -13,14 +12,14 @@ Software Requirements
1312

1413
* Python (2.7, 3.3 or later)
1514
* Icarus Verilog (0.9.6 or later)
16-
- vparser.preprocessor.py uses 'iverilog -E' command instead of the preprocessor.
15+
- pyverilog.vparser.preprocessor.py uses 'iverilog -E' command as the preprocessor.
1716
- 'apt-get install iverilog'
1817
* Graphviz and Pygraphviz (Python3 does not support Pygraphviz)
19-
- graphgen.py in dataflow and controlflow.py in controlflow (without --nograph option) use Pygraphviz with Python 2.7.
20-
- If you do not use graphgen.py and controlflow.py (without --nograph) option, Python 3 is OK.
18+
- pyverilog.dataflow.graphgen and pyverilog.controlflow.controlflow (without --nograph option) use Pygraphviz (on Python 2.7).
19+
- If you do not use graphgen and controlflow (without --nograph) option, Python 3.x is fine.
2120
* Jinja2 (2.7 or later)
2221
- ast\_code\_generator requires jinja2 module.
23-
- 'pip3 install jinja2'
22+
- 'pip3 install jinja2' (for Python 3.x) or 'pip install jinja2' (for Python 2.7)
2423

2524

2625
Tools
@@ -322,8 +321,7 @@ License
322321
Apache License 2.0
323322
(http://www.apache.org/licenses/LICENSE-2.0)
324323

325-
This software package includes PLY-3.4.
326-
The license of PLY is BSD.
324+
This software package includes PLY-3.4 in "vparser/ply". The license of PLY is BSD.
327325

328326

329327
Copyright and Contact

0 commit comments

Comments
 (0)