DEV/UI: consider removing README.md and pointing to the documentation site

SamsungDS / Spex

lint- and extract figures from NVMe specification documents.

https://samsungds.github.io/Spex/

3 stars 2 forks source link

DEV/UI: consider removing README.md and pointing to the documentation site #15

Open jwdevantier opened 1 year ago

jwdevantier commented 1 year ago

README.md will always be a poor substitute for reading the documentation. However, reading the raw RST files is not particularly user-friendly - so let's point the user toward the github page.

safl commented 1 year ago

Agree, here are some additional considerations:

It should provide a decent GitHUB Landing page (primary use now)
Could be made re-usable in PyPI package descriptions
Could be made re-usable for the sphinx-doc landing page
Could contain misc. badges (pypi, docs, ci, docker images)