Skip to content

Revamp README#734

Merged
nicoddemus merged 1 commit intopytest-dev:masterfrom
nicoddemus:revamp-readme
Dec 2, 2021
Merged

Revamp README#734
nicoddemus merged 1 commit intopytest-dev:masterfrom
nicoddemus:revamp-readme

Conversation

@nicoddemus
Copy link
Copy Markdown
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

@nicoddemus nicoddemus force-pushed the revamp-readme branch 4 times, most recently from d39feaf to f4f8846 Compare November 29, 2021 15:37
Copy link
Copy Markdown
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!

Comment thread README.rst Outdated
* 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
Copy Markdown
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