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

Renew the readme #2692

Merged
merged 3 commits into from May 25, 2017
Merged

Renew the readme #2692

merged 3 commits into from May 25, 2017

Conversation

beam2d
Copy link
Member

@beam2d beam2d commented May 2, 2017

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).

@beam2d beam2d added the v2 label May 2, 2017
@mitmul mitmul self-assigned this May 9, 2017
Copy link
Member

@mitmul mitmul left a 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).
Copy link
Member

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))

Copy link
Member

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.

@beam2d
Copy link
Member Author

beam2d commented May 25, 2017

Fixed following your suggestions, and merged the latest v2.

@mitmul
Copy link
Member

mitmul commented May 25, 2017

LGTM

@mitmul mitmul merged commit e2842c9 into _v2 May 25, 2017
@delta2323 delta2323 modified the milestone: v2.0.0 May 26, 2017
@unnonouno unnonouno deleted the _v2-readme branch June 1, 2017 09:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants