如何为你的 GitHub 开源项目写一份优秀的 README.md 文档?

分享发现 · outofmemory · 于 发布 · 最后由 barryhappy回复 · 4205 次阅读
390

Project Title 项目名称

One Paragraph of project description goes here.一段精简的项目描述

Getting Started.使用手册

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites.项目使用条件

What things you need to install the software and how to install them.使用项目需要什么样的开发环境

Give examples

Installing 安装

A step by step series of examples that tell you have to get a development env running

Say what the step will be

Give the example

And repeat

until finished

End with an example of getting some data out of the system or using it for a little demo

Running the tests

Explain how to run the automated tests for this system

Break down into end to end tests

Explain what these tests test and why

Give an example

And coding style tests

Explain what these tests test and why

Give an example

Deployment

Add additional notes about how to deploy this on a live system

Built With

  • Dropwizard - The web framework used
  • Maven - Dependency Management
  • ROME - Used to generate RSS Feeds

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

  • Hat tip to anyone who's code was used
  • Inspiration
  • etc
共收到 3 条回复
390

Synopsis 项目大纲

At the top of the file there should be a short introduction and/ or overview that explains what the project is. This description should match descriptions added for package managers (Gemspec, package.json, etc.)

Code Example 代码示例

Show what the library does as concisely as possible, developers should be able to figure out how your project solves their problem by looking at the code example. Make sure the API you are showing off is obvious, and that your code is short and concise.

Motivation 创作动机

A short description of the motivation behind the creation and maintenance of the project. This should explain why the project exists.

Installation 如何安装

Provide code examples and explanations of how to get the project.

API Reference

Depending on the size of the project, if it is small and simple enough the reference docs can be added to the README. For medium size to larger projects it is important to at least provide a link to where the API reference docs live.

Tests 项目运行效果

Describe and show how to run the tests with code examples.

Contributors 参与者介绍

Let people know how they can dive into the project, include important links to things like issue trackers, irc, twitter accounts if applicable.

License

A short snippet describing the license (MIT, Apache, etc.)

2553

个人有一个小经验是:中英文的readme各写一份
——一般我们都是在先在中文世界宣传,中文的readme能让国内的同胞们快速了解,这样积累一些用户之后,项目就更容易被全宇宙的其他程序员看到,这时候英文的readme就派上用场啦~

需要 登录 后方可回复, 如果你还没有账号请点击这里 注册