마크다운
마크다운 문법으로 작성된 파일.md
사용법이 매우 쉽고, 빠르게 문서를 정리할 수 있음
마크다운 장점
1. 문법이 쉽다.
2. 관리가 쉽다.
3. 지원 가능한 플랫폼과 프로그램이 다양하다.
마크다운 단점
1. 표준이 없어 사용자마다 문법이 다를 수 있다.
2. 모든 html마크업을 대신하지는 못한다.
일반적인 readme 구조
1. 프로젝트 설명
- 프로젝트 명
- 프로젝트 소개
2. 프로젝트 정보
- 설치
- 컴파일 방법, 사용환경, 브라우저 서포트
- 간단한 사용 방법 및 예시
3. 라이선스
저작물의 수정 배포에 대한 권한이나 저작줜에 대한 조항들
4. 외부 리소스 정보
프로젝트에 포함된 외부 코드나 리소스 정보
(각각의 출처 및 배포 라이선스)
5. Code Status
- [build | passing]과 같은 정보를 작성한다.
