hdl / pyHDLParser

Simple Python parser for extracting HDL (VHDL or Verilog) documentation
https://HDL.github.io/pyHDLParser
MIT License
17 stars 10 forks source link

README is out of date #8

Open vvvverre opened 2 years ago

vvvverre commented 2 years ago

There are a few things in the README file which may confuse potential users. Below is an (incomplete) list of things that need considering. I will submit a new PR to cover some of the easy points.

For the last point we could try a few solutions:

  1. We could try to get in touch with kevinpt to see if we can get the PyPI hdlparse package to point to this repo
  2. If we cannot reach kevinpt, perhaps PyPI could transfer ownership?
  3. We could bump the version to 2.0.0, then make a new hdlparse2 package on PyPI?
  4. We could use a different name altogether for a new PyPI package?

Looking forward to hearing your thoughts on this topic.

Cheers, Wouter

umarcor commented 2 years ago

With regard to naming and pip, see https://github.com/hdl/pyHDLParser/pull/2#issuecomment-926547629.