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

Jump to bottom

Improve readme #1544

Closed
veripoolbot opened this issue Oct 6, 2019 · 1 comment
Closed

Improve readme #1544

veripoolbot opened this issue Oct 6, 2019 · 1 comment
Assignees
@wsnyder
Labels
area: documentation Issue involves documentation resolution: fixed Closed; fixed

Comments

@veripoolbot
Copy link
Contributor

Author Name: Wilson Snyder (@wsnyder)
Original Redmine Issue: 1544 from https://www.veripool.org

Original Assignee: Wilson Snyder (@wsnyder)

The existing readme document is really an install document.

Readme should be more modern, github-like. This probably means contents similar to the Verilator landing page (https://www.veripool.org/projects/verilator/wiki/Intro) and point to the contributing, internals, and a new separate docs/installing.adoc file.
@veripoolbot
Copy link
Contributor Author

Original Redmine Comment
Author Name: Wilson Snyder (@wsnyder)
Original Date: 2019-11-08T03:34:18Z

Rewrote readme, install, and updated URLs.

@veripoolbot veripoolbot added area: documentation Issue involves documentation resolution: fixed Closed; fixed labels Dec 22, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@wsnyder wsnyder

Labels
area: documentation Issue involves documentation resolution: fixed Closed; fixed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@wsnyder @veripoolbot