Skip to content
This repository has been archived by the owner on Aug 18, 2023. It is now read-only.

Move install and contributing instructions to readme file #238

Closed
wants to merge 3 commits into from

Conversation

zaqqwerty
Copy link
Contributor

@zaqqwerty zaqqwerty commented Apr 26, 2022

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 zaqqwerty marked this pull request as ready for review April 26, 2022 18:52
@zaqqwerty zaqqwerty requested a review from farice April 26, 2022 18:56
Copy link
Contributor

@farice farice left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not sure the motivation for this - e.g. seems having separate contributing.md is an OSS standard?

and why not let pypi see the readme?

@zaqqwerty
Copy link
Contributor Author

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

@zaqqwerty zaqqwerty closed this Apr 29, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Integrate install and contributing docs into readme
2 participants