Skip to content

Commit 42d37f1

Browse files
committed
Updated README
1 parent 7a28edb commit 42d37f1

File tree

2 files changed

+21
-27
lines changed

2 files changed

+21
-27
lines changed

README.md

Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -71,20 +71,13 @@ To write a testing code, please refer the existing testing examples in "tests" d
7171
If the pull request code passes all the tests successfully and has no obvious problem, it will be merged to the *develop* branch by the main committers.
7272

7373

74-
Documentation
75-
==============================
76-
77-
To be described.
78-
79-
8074
Installation
8175
==============================
8276

8377
Requirements
8478
--------------------
8579

8680
- Python3: 3.6 or later
87-
8881
- Icarus Verilog: 10.1 or later
8982

9083
```
@@ -97,23 +90,27 @@ sudo apt install iverilog
9790
pip3 install jinja2
9891
```
9992

100-
Optional Installation
93+
Optional installation for testing
10194
--------------------
10295

96+
These are required for automatic testing of **tests**.
97+
We recommend to install these testing library to verify experimental features.
98+
10399
- pytest: 3.8.1 or later
104100
- pytest-pythonpath: 0.7.3 or later
105101

106-
These are required for the testing execution of test codes in tests and examples.
107-
108102
```
109103
pip3 install pytest pytest-pythonpath
110104
```
111105

112-
- Graphviz: 2.38.0 or later
113-
- Pygraphviz: 1.3.1 or later
106+
Optional installation for visualization
107+
--------------------
114108

115109
These are required for graph visualization by dataflow/graphgen.py and controlflow/controlflow_analyzer.py.
116110

111+
- Graphviz: 2.38.0 or later
112+
- Pygraphviz: 1.3.1 or later
113+
117114
```
118115
sudo apt install graphviz
119116
pip3 install pygraphviz
@@ -122,7 +119,7 @@ pip3 install pygraphviz
122119
Install
123120
--------------------
124121

125-
Install Pyverilog:
122+
Now you can install Pyverilog using setup.py script:
126123

127124
```
128125
python3 setup.py install

README.rst

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -81,19 +81,13 @@ If the pull request code passes all the tests successfully and has no
8181
obvious problem, it will be merged to the *develop* branch by the main
8282
committers.
8383

84-
Documentation
85-
=============
86-
87-
To be described.
88-
8984
Installation
9085
============
9186

9287
Requirements
9388
------------
9489

9590
- Python3: 3.6 or later
96-
9791
- Icarus Verilog: 10.1 or later
9892

9993
::
@@ -106,25 +100,28 @@ Requirements
106100

107101
pip3 install jinja2
108102

109-
Optional Installation
110-
---------------------
103+
Optional installation for testing
104+
---------------------------------
105+
106+
These are required for automatic testing of **tests**. We recommend to
107+
install these testing library to verify experimental features.
111108

112109
- pytest: 3.8.1 or later
113110
- pytest-pythonpath: 0.7.3 or later
114111

115-
These are required for the testing execution of test codes in tests and
116-
examples.
117-
118112
::
119113

120114
pip3 install pytest pytest-pythonpath
121115

122-
- Graphviz: 2.38.0 or later
123-
- Pygraphviz: 1.3.1 or later
116+
Optional installation for visualization
117+
---------------------------------------
124118

125119
These are required for graph visualization by dataflow/graphgen.py and
126120
controlflow/controlflow_analyzer.py.
127121

122+
- Graphviz: 2.38.0 or later
123+
- Pygraphviz: 1.3.1 or later
124+
128125
::
129126

130127
sudo apt install graphviz
@@ -133,7 +130,7 @@ controlflow/controlflow_analyzer.py.
133130
Install
134131
-------
135132

136-
Install Pyverilog:
133+
Now you can install Pyverilog using setup.py script:
137134

138135
::
139136

0 commit comments

Comments
 (0)