This is an example project, aim to be a reference of how project source code and document should be organized. (项目详细介绍,紧接标题之后,一般是一段或几段话,必须有)
Second paragraph.
- Homepage: http://netease.github.com/projectname (项目相关链接,紧接详细介绍之后,没有的项可以不写)
- Mailing list: https://groups.google.com/group/projectname
- Documentation: http://projectname.readthedocs.org
- Wiki: https://github.com/netease/projectname/wiki/
- Issues: https://github.com/netease/projectname/issues/
- Tags: java, spring (项目相关标签,如编写语言和项目的用途,常见的标签有
web
、java
、c
、html5
、libary
、plugin
等,必须有,并且放到最后一项)
clone this repo
git clone git://github.com/netease/example.git
and ...
Write document here.
Fork this project on GitHub, add your improvement, push it to a branch in your fork named for the topic, send a pull request.
You can also file bugs or feature requests under the issues page on GitHub, or join us on google groups https://groups.google.com/group/example-dev
...
...