Move install and contributing instructions to readme file

google / qhbm-library

Quantum Hamiltonian-Based Models built on TensorFlow Quantum

https://qhbm-library.readthedocs.io/en/latest/

Apache License 2.0

40 stars 15 forks source link

Closed zaqqwerty closed 2 years ago

zaqqwerty commented 2 years ago

Resolves #203

Combines the docs/INSTALL.md and docs/contributing.md into the top level README.md file. Other tweaks include:

Add instructions to upgrade poetry to version 1.2
Update links to point to the README instead of the separate docs files
Combine stock Code Reviews section with the Developer Workflow section
Remove pointer to README from pyproject.toml, so readme contents are not copied to PyPI (?thoughts on this point?)

zaqqwerty commented 2 years ago

No longer relevant after #240, makes sense for docs to live split apart, can be linked to and referenced more easily that way