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
Renew the readme #2692
Renew the readme #2692
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I reviewed and commented on two points.
I wonder whether the top menu elements which are horizontally listed should be a hierarchical list such as the current README adopts or not...
README.md
Outdated
yum install hdf5-devel | ||
``` | ||
Any contributions to Chainer are welcome! | ||
If you want to file an issue or send a pull request, [follow the contribution guide](https://docs.chainer.org/contribution.html). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"please follow" would be more polite?
README.md
Outdated
| Examples ([Official](https://github.com/pfnet/chainer/blob/master/examples), [External](https://github.com/pfnet/chainer/wiki/External-examples)) | ||
| Forum ([en](https://groups.google.com/forum/#!forum/chainer), [ja](https://groups.google.com/forum/#!forum/chainer-jp)) | ||
| Slack ([en](https://bit.ly/chainer-slack), [ja](https://bit.ly/chainer-jp-slack)) | ||
| Twitter ([en](https://twitter.com/ChainerOfficial), [ja](https://twitter.com/ChainerJP)) | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How about making these links bold style? It could be hard for some people to notice.
# Conflicts: # README.md
Fixed following your suggestions, and merged the latest v2. |
LGTM |
I rewrote the readme for v2. It is simpler than the current one and easier to find the appropriate place to get the information that users want (which is the most important thing that readme should provide).