Best-README-Template README

The project's README from github.com/othneildrew/Best-README-Template. As one markdown file: README.md.

Contributors Forks Stargazers Issues Unlicense License LinkedIn


Logo

Best-README-Template

An awesome README template to jumpstart your projects!
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

Product Name Screen Shot

There are many great README templates available on GitHub; however, I didn't find one that really suited my needs so I created this enhanced one. I want to create a README template so amazing that it'll be the last one you ever need -- I think this is it.

Here's why:

Of course, no one template will serve all projects since your needs may be different. So I'll be adding more in the near future. You may also suggest changes by forking this repo and creating a pull request or opening an issue. Thanks to all the people who have contributed to expanding this template!

Use the BLANK_README.md to get started.

(back to top)

Built With

This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

Installation

Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.

  1. Get a free API Key at https://example.com
  2. Clone the repo
    git clone https://github.com/github_username/repo_name.git
  3. Install NPM packages
    npm install
  4. Enter your API in config.js
    const API_KEY = 'ENTER YOUR API';
  5. Change git remote url to avoid accidental pushes to base project
    git remote set-url origin github_username/repo_name
git remote -v # confirm the changes

(back to top)

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

(back to top)

Roadmap

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Top contributors:

contrib.rocks image

(back to top)

License

Distributed under the Unlicense License. See LICENSE.txt for more information.

(back to top)

Contact

Your Name - @your_twitter - [email protected]

Project Link: https://github.com/your_username/repo_name

(back to top)

Acknowledgments

Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!

(back to top)

Best-README-Template (othneildrew/Best-README-Template)

Searching Database…

16.4K ·GitHub
Best-README-Template
这是什么？这是一个 README 模板，帮助你快速为自己的 GitHub 项目撰写结构完整、外观精良的 README.md，内置 “About”、“Getting Started”、“Usage”、“Roadmap” 和 “Contact” 等现成章节。
这是我要运行的工具，还是只需复制的 Markdown 文件？它是一个静态模板，不是软件：你需要把 README.md（或空白的 BLANKREADME.md）复制到自己的仓库中，然后修改文字、徽章和链接，使其与你的项目相符。
我该如何开始使用？Fork 或复制该仓库，然后将文件顶部的占位项目名称、描述、截图以及徽章和链接替换为你自己项目的信息，并根据实际情况填写各个章节。
模板中的示例安装和使用步骤能直接用于我的项目吗？不能。“Prerequisites”、“Installation”和“Usage”中的步骤（例如 “Get a free API Key”、“npm install”）只是占位示例，你需要替换为自己项目真实的安装说明。
模板顶部的徽章是做什么用的？它们是占位用的 shields.io 徽章，分别用于贡献者、Fork 数、Star 数、Issue、许可证以及联系链接。改造模板后，应将它们指向你自己的仓库。
“Built With” 部分是用来展示什么的？这里用来列出项目所基于的主要框架或库。模板已附带 Next.js、React、Vue、Angular、Svelte、Laravel、Bootstrap 和 jQuery 的示例徽章，你可以替换为自己的技术栈。
作者为什么要做这个模板，而不是每次从头写 README？作者不想在每个项目上重复编写相同的 README，并希望遵循 DRY 原则。因此这个模板提供了一套完整、可复用的结构，并已预先填好 “Roadmap” 和 “Contributing” 等部分。
如果我不想要示例内容，有空白的起点吗？有。BLANKREADME.md 就是同一模板的空白版本，你无需先删除示例文字，即可从零开始填写各个章节。
What are similar projects?project-layout, awesome-readme, readme-md-generator, architecture-decision-record, opensource.guide, git-flight-rules, html5-boilerplate, Awesome-Profile-README-templates
Which topics is it in?readme, starter-kit, boilerplate, template, best-practices, github, beginner-friendly, guide, documentation, markdown, resources, tool
Creator
othneildrew
Size
0.2 MB
Stars
16.4K
Updated
CommitApr 18Releasev1.1.2Dec 07
Age
7y
Commits · 90 Days