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

Revamp README #734

Merged
merged 1 commit into from
Dec 2, 2021
Merged

Revamp README #734

merged 1 commit into from
Dec 2, 2021

Conversation

nicoddemus
Copy link
Member

@nicoddemus nicoddemus commented Nov 29, 2021

  • Use a document title
  • Show a "short and sweet" section at the beginning highlighting the main usage of the plugin.
  • Add a table of contents.
  • Use a dedicated howto section at the end.
  • Move the OVERVIEW section to the main README.

A preview can be seen here: https://github.com/nicoddemus/pytest-xdist/tree/revamp-readme

Copy link
Member

@bluetech bluetech left a comment

Choose a reason for hiding this comment

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

Looks nicer to me!

README.rst Outdated Show resolved Hide resolved
* Use a document title.
* Show a "short and sweet" section at the beginning highlighting the main usage of the plugin.
* Add a table of contents.
* Use a dedicated howto section at the end.
* Move the OVERVIEW section to the main README.
@nicoddemus
Copy link
Member Author

@RonnyPfannschmidt gentle ping. 😁

@nicoddemus nicoddemus merged commit 110c114 into pytest-dev:master Dec 2, 2021
@nicoddemus nicoddemus deleted the revamp-readme branch December 2, 2021 13:07
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

Successfully merging this pull request may close these issues.

3 participants