Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README is out of date #8

Open
1 of 3 tasks
vvvverre opened this issue Jan 27, 2022 · 1 comment
Open
1 of 3 tasks

README is out of date #8

vvvverre opened this issue Jan 27, 2022 · 1 comment

Comments

@vvvverre
Copy link

vvvverre commented Jan 27, 2022

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.

  • Some links are out of date (pointing to my old repo, which has now been renamed) (see PR Update README #9)
  • The version number hasn't been updated since this fork started. It would be good to have a new version number to identify library versions based on this repo.
  • PyPI links to an old version (kevinpt's). This is confusing because when users run pip install hdlparse they won't get the version from this repo.

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

@vvvverre vvvverre mentioned this issue Jan 27, 2022
@umarcor
Copy link
Member

umarcor commented Feb 1, 2022

With regard to naming and pip, see #2 (comment).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants