GitHub의 README를 작성하기위한 이로하

소개

깨끗한 README를 쓰려면 어떻게 하면 좋을지, 나름대로의 룰을 만들었으므로 기사에 정리하고 싶습니다.

사용할 Git 호스팅 서비스

GitHub

처음에

GitHub에서 원격 리포지토리를 만들 때 GitHub가 기본적으로 README 템플릿을 제공하므로 그것을 사용하도록합시다.
다음은 PHP 프레임 워크인 Laravel을 사용하여 MIT 라이센스로 프로젝트를 게시하는 경우의 설정 샘플입니다.

쓰는 것이 좋은 항목

배지 목록

잘 보이는 ↓입니다. 자세한 내용은 아래를 참조하십시오.

Introduction

그 프로젝트의 간단한 소개문을 1행 정도로 간단하게 정리합니다.

Demonstration

그 프로젝트의 간단한 데모 이미지와 gif 동영상을 붙여서 한눈에 어떤 프로젝트인지 알 수 있도록합니다

Features

그 프로젝트의 특징, 이 프로젝트를 사용하는 것으로 어떤 목적을 이룰 수 있는가를 상세하게 기재합니다

Requirements

프로젝트의 요구 사항. 필요한 언어 및 라이브러리 버전 등을 나열합니다

Installation

프로젝트가 패키지로 게시되면 설치 방법, 설치 명령을 설명합니다

.

Usage

그 프로젝트의 사용법을 글머리 기호로 기재합니다. 덧붙여 상세한 사용법에 대해서는 다른 항목이나 wiki등에 기재합니다

Sample

프로젝트를 사용하기위한 샘플 코드와 같은 프로젝트 사용에 대한 자세한 이미지와 사용법을 설명합니다

Contributing

프로젝트에 기여하는 방법에 대한 링크 작성

CONTRIBUTING.md라는 파일을 준비하고 거기에 프로젝트 기여 규칙을 설명하고 링크를 README에 설명합니다

License

라이센스에 대해 설명

This package is open-sourced software licensed under the [MIT license](https://choosealicense.com/licenses/mit/)

정리하면...

# Hogehoge Project
[![Laravel 6|7|8](https://img.shields.io/badge/Laravel-6|7|8-orange.svg)](http://laravel.com)
[![License](https://poser.pugx.org/stepupdream/blueprint/license)](//packagist.org/packages/stepupdream/blueprint)

## Introduction

## Demonstration

## Features

## Requirements 

## Installation 

## Usage

## Sample

## Contributing

## License

The Blueprint is open-sourced software licensed under the [MIT license](https://choosealicense.com/licenses/mit/)

README에 사용되는 배지 정보

아래에서 만들 수 있습니다. URL을 자신의 README에 붙여 넣는 것만으로 외형의 깨끗한 README로 할 수 있습니다.
※수치 부분의 값은 반영에 조금 시간이 걸리는 경우가 있는 것 같습니다



그 외, 각종 서비스에 관한 배지는 각각의 서비스내에서 배포되고 있기 때문에 그것을 이용합니다.
※GitHub Actions의 배지라면, GitHub Actions의 페이지내에서 링크가 제공되고 있습니다

GitHub Actions의 배지 정보

여기에서 링크를 얻을 수 있습니다.

참고