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

Better default README.rst #51

Closed
StephanErb opened this issue May 4, 2015 · 2 comments
Closed

Better default README.rst #51

StephanErb opened this issue May 4, 2015 · 2 comments
Assignees
Labels
enhancement New feature or request
Milestone

Comments

@StephanErb
Copy link
Contributor

Many users of pyscaffold tend to keep the default README.rst. Unfortuantely, this readme is tailored for the user of pyscaffold but not for any user of the project, who only wants to find out what the project does and how it can be run/tested.

The readme should therefore be shorter and more to the point without any long explanations. It could also contain an elevator pitch of the project.

@ghost
Copy link

ghost commented May 5, 2015

Yes, I think something along the lines of "This project has been set up using pyscaffold. For details and usage information on pyscaffold see https://github.com/blue-yonder/pyscaffold." would be good. The remaining content of the README.rst should then be added to pyscaffold's README.md. Alternatively it could be stored in a HOWTO.md.

@FlorianWilhelm FlorianWilhelm added the enhancement New feature or request label May 5, 2015
@FlorianWilhelm FlorianWilhelm added this to the 2.2 milestone May 5, 2015
@FlorianWilhelm FlorianWilhelm self-assigned this May 5, 2015
@FlorianWilhelm
Copy link
Member

Thanks for reporting. I used a variant of the wording of @MatthiasBach.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants