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

Move content from README to website #36

Closed
vitaut opened this issue Apr 18, 2014 · 3 comments
Closed

Move content from README to website #36

vitaut opened this issue Apr 18, 2014 · 3 comments

Comments

@vitaut
Copy link
Contributor

vitaut commented Apr 18, 2014

The README file is too big. Some of the content needs to be moved to the website and updated.

@vitaut
Copy link
Contributor Author

vitaut commented Dec 19, 2014

@vitaut
Copy link
Contributor Author

vitaut commented May 23, 2015

The README contains the following sections:

  • Features
  • Examples
  • Projects using this library
  • Motivation
  • What users say
  • Benchmarks
  • License
  • Links
  • Acknowledgments

Features and Examples should be there to give a short overview of the library. Projects using this library and Motivation also belong to the README rather than the docs. "What users say" can be moved to the front page of the docs as in http://sphinx-doc.org/ . Benchmarks are tricky because the result change with versions but adding them to the docs may be confusing because there will be different benchmark results which are difficult to compare. It would be better to have something like http://speed.pypy.org/, but for now it can stay in the README. License has been moved to a separate file. Links and Acknowledgements can also remain in the README.

@vitaut
Copy link
Contributor Author

vitaut commented May 23, 2015

Completed in eaf30d5.

@vitaut vitaut closed this as completed May 23, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants
@vitaut and others