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.

Sign up for GitHub

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

Jump to bottom

Improve the README #819

Closed
obestwalter opened this issue May 14, 2018 · 3 comments
Closed

Improve the README #819

obestwalter opened this issue May 14, 2018 · 3 comments
Assignees
@obestwalter @gaborbernat
Labels
area:documentation level:medium rought estimate that this might be neither easy nor hard to implement
Milestone
3.7

Comments

@obestwalter
Copy link
Member

The README is a bit terse and not a good starting point yet. I think it should already explain the most important concepts and have some good examples for basic usages showacsing some important functionality. A lot can be filched from the existing docs and edited for the README, I think.

Some things to mention:

  • tox-quickstart
  • plugins
  • environment substitution
  • posargs
  • tox as CI frontend and developer task automation tool (not just for testing/packaging), e.g. build docs, pre-commit, etc.
  • testing projects that don't even have a setup.py with skipsdist
  • testing projects that don't build a package with skispddist + usedevelop
  • ...

It could also be written in Markdown now, as the new https://pypi.org supports it.
@obestwalter obestwalter added needs:discussion It's not quite clear if and how this should be done area:documentation level:medium rought estimate that this might be neither easy nor hard to implement labels May 14, 2018
@obestwalter obestwalter mentioned this issue May 14, 2018
Closed
@gaborbernat gaborbernat added this to the 3.5 milestone Sep 18, 2018
@gaborbernat gaborbernat self-assigned this Oct 6, 2018
@gaborbernat gaborbernat modified the milestones: 3.5, 3.6 Oct 8, 2018
@ssbarnea
Copy link
Member

ssbarnea commented Nov 13, 2018 •
edited
Loading

I would add a section about tox related projects, official and non-official ones, plugins or stanalone. This would be very useful for users, and also avoid cases where people would ask about features that are already provided by a 3rd tool or extension.

As a note, this should not be done in a single PR as it would take forever to review -- better to slowly improve the readme in several incremental PRs.

@obestwalter obestwalter mentioned this issue Nov 14, 2018
Closed
@obestwalter obestwalter self-assigned this Nov 14, 2018
@gaborbernat gaborbernat modified the milestones: 3.6, 3.7 Dec 16, 2018
@obestwalter obestwalter mentioned this issue Jan 2, 2019
Merged
@obestwalter
Copy link
Member Author

obestwalter commented Jan 2, 2019 •
edited by unfurl-links bot
Loading

I opened a new PR and think this can be merged.

@ssbarnea - we have a related project section in the docs already (https://tox.readthedocs.io/en/latest/#related-projects), but we might add this in another PR like you suggested. Maybe also a clearer mention of the plugins.

@obestwalter obestwalter removed the needs:discussion It's not quite clear if and how this should be done label Jan 2, 2019
@gaborbernat
Copy link
Member

I think we approved and merged the PR.

@tox-dev tox-dev locked and limited conversation to collaborators Jan 14, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@obestwalter obestwalter

@gaborbernat gaborbernat

Labels
area:documentation level:medium rought estimate that this might be neither easy nor hard to implement
Projects
None yet
Milestone
3.7
Development

No branches or pull requests
3 participants
@ssbarnea @obestwalter @gaborbernat