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, который помогает быстро написать аккуратный и хорошо структурированный README.md для ваших проектов на GitHub. В нём уже есть готовые разделы: «О проекте», «Начало работы», «Использование», «Дорожная карта» и «Контакты».
Это программа, которую нужно запускать, или просто файл markdown, который я копирую?Это статичный шаблон, а не программа: вы копируете README.md (или пустой BLANKREADME.md) в свой репозиторий и редактируете текст, бейджи и ссылки под свой проект.
Как начать пользоваться?Сделайте форк или скопируйте репозиторий, затем замените в начале файла название проекта-заглушки, описание, скриншот и ссылки на бейджи на данные своего проекта и заполните каждый раздел, если он вам подходит.
Примеры установки и использования сразу подойдут для моего проекта?Нет, разделы «Требования», «Установка» и «Использование» (например, «Получите бесплатный API-ключ» и npm install) содержат только примеры-заглушки, которые нужно заменить на реальные инструкции по настройке вашего проекта.
Для чего нужны бейджи вверху шаблона?Это заглушки-бейджи shields.io: для числа участников, форков, звёзд и открытых задач, для лицензии и для ссылки на контакт. Их нужно перенастроить на ваш репозиторий, когда вы адаптируете шаблон.
Для чего нужен раздел «Построено на»?Здесь перечисляются основные фреймворки и библиотеки, на которых построен проект. Уже добавлены примеры бейджей для Next.js, React, Vue, Angular, Svelte, Laravel, Bootstrap и jQuery, которые нужно заменить на ваш стек.
Зачем автор сделал это, а не писал README с нуля каждый раз?Автор хотел перестать повторять одну и ту же работу над README в каждом проекте и следовать принципу DRY, поэтому шаблон объединяет полную многократно используемую структуру с уже заполненными разделами «Дорожная карта» и «Участие в разработке».
Есть ли пустая заготовка, если мне не нужен пример?Да, BLANKREADME.md — это пустая версия того же шаблона, так что можно заполнять разделы с нуля, не удаляя сначала примерный текст.
What are similar projects?project-layout, awesome-readme, readme-md-generator, opensource.guide, architecture-decision-record, git-flight-rules, Awesome-Profile-README-templates, html5-boilerplate
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