## readme.md 샘플 Github 프로젝트 readme.md 템플릿 readme는 설명 파일로 사용되며 시청자가 프로젝트를 빠르게 이해하고 Bird의 시선을 볼 수 있도록하는 것이 목적입니다. 이렇게하려면 readme을 작성할 때 계층 구조와 형식에주의를 기울여야하며 Markdown으로 작성하는 것이 가장 좋습니다. 일반적으로 적어도 세 부분이 포함되어 있습니다. 첫 번째는 프로젝트 배경과 용도를 소개하는 것입니다. 두 번째는 방법 (가져 오기/설치, 노출 된 통화 인터페이스 등)을 사용하는 것입니다. 세 번째는 프로토콜을 준수하는 것입니다. 추신 (초보자는 고급 =. =)를 작성할 필요가없는 것 같습니다. 자세한 내용은 Github에 배치 된이 템플릿을 참조 할 수 있습니다.
인원 : Lixinyi, LXY, WXM, LHZ, SH ## github 주소 https://github.com/tanelmer/hisuncle ## 데모 주소 http://webcafe.pub/ife/stage1/ ## github project readme.md 템플릿
#### 예:
프로젝트가 사용되는 경우는 다음과 같습니다. APK 다운로드 링크를 넣거나 스크린 샷 몇 개를 넣을 수 있습니다.
(예제는 처음부터 풀려나 시청자가 자신이 찾고있는 것을 찾고 있는지 알 수 있도록).
### 기능 (선택 사항)
특징 a
기능 b
### 원리 설명 (옵션) 프로젝트가 어떤 아이디어를 기반으로 설계했는지 설명합니다.
Gradle :
compile 'xxx'(프로젝트 구성 방법을 설명하고 Android 오픈 소스 라이브러리가 Gradle로 가져옵니다)
### 사용 방법, 단계는 무엇이며 어떤 인터페이스가 있는지.
예를 들어, 난독 화 방법 등
### todo (선택 사항) 다음 개발/유지 보수 계획.
계약을 준수했습니다
파일을 무시하십시오