Skip to content

Commit d0ca8f0

Browse files
committed
Update README.rst
1 parent a770dcd commit d0ca8f0

File tree

1 file changed

+14
-8
lines changed

1 file changed

+14
-8
lines changed

README.rst

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,26 +5,22 @@ Hdlparse
55

66
Hdlparse is a simple package implementing a rudimentary parser for VHDL and Verilog. It is not capable of fully parsing the entire language. Rather, it is meant to extract enough key information from a source file to create generated documentation.
77

8-
This library is used by the `Symbolator <https://github.com/kevinpt/symbolator>`_ diagram generator.
8+
This library is forked from `kevinpt <https://github.com/kevinpt/hdlparse>`_ via `zhelnio <https://github.com/zhelnio/hdlparse>`_. The aim of this fork is to provide some bug fixes and additional features to zhelnio's version of Hdlparse. A list of changes is included at the bottom of this README.
99

1010
For VHDL this library can extract component, subprogram, type, subtype, and constant declarations from a package. For Verilog it can extract module declarations (both 1995 and 2001 syntax).
1111

1212

1313
Requirements
1414
------------
1515

16-
Hdlparse requires either Python 2.7 or Python 3.x and no additional libraries.
17-
18-
The installation script depends on setuptools. The source is written in
19-
Python 2.7 syntax but will convert cleanly to Python 3 when the installer
20-
passes it through 2to3.
16+
Hdlparse requires Python 3.x and no additional libraries. This version of Hdlparse is not compatible with Python2.
2117

2218

2319
Download
2420
--------
2521

2622
You can access the Hdlparse Git repository from `Github
27-
<https://github.com/kevinpt/hdlparse>`_. You can install direct from PyPI with the "pip"
23+
<https://github.com/vvvverre/hdlparse>`_. You can install direct from PyPI with the "pip"
2824
command if you have it available.
2925

3026
Installation
@@ -55,7 +51,7 @@ You can also use ``pip`` to get the latest development code from Github:
5551

5652
.. code-block:: sh
5753
58-
> pip install --upgrade https://github.com/kevinpt/hdlparse/tarball/master
54+
> pip install --upgrade https://github.com/vvvverre/hdlparse/tarball/master
5955
6056
If you manually downloaded a source package or created a clone with Git you can install with the following command run from the base Hdlparse directory:
6157

@@ -74,3 +70,13 @@ Documentation
7470
The full documentation is available online at the `main Hdlparse site
7571
<http://kevinpt.github.io/hdlparse/>`_.
7672

73+
74+
Changes
75+
-------
76+
77+
A list of changes compared to the upstream is listed here:
78+
79+
* Improved support for VHDL and Verilog generics
80+
* PEP8 compatible formatting
81+
* Remove Python2 support
82+
* Provide debugging information using the Python logging module

0 commit comments

Comments
 (0)