프로젝트 README.md

여태까지 너무 대충 README.md를 적었다... 이번에 길게 프로젝트를 하면서 좀 예쁘게 꾸미고 싶다는 생각이 들었다. 

 

그래서 차라리 다른 사람들은 기본적으로 무슨 내용이 들어가야 할지 한번 알아보고 참고 하기로 했다.

 

사람들마다 넣는 내용이 다르므로 내가 이번 프로젝트에 넣을 내용들만 넣기로 했다.

앱 프로젝트의 README.md 링크

https://github.com/tvroom88/Android_Study_App/edit/main/README.md

 

참고할만한 링크

https://github.com/yu-so-young2/yobangcok

1. 내용

(1) 프로젝트 제목
(2) 프로젝트 로고나 이미지 : 프로젝트를 대표하는 사진 or 로고

(3) 프로젝트 정보 및 소개 : 해당 프로젝트를 진행한 목적 소개 && 개발 기간 && 간단 프로젝트 소개

(4) 팀 소개는 생략 :  개인프로젝트라서 생략

(5) 구글 플레이스토어 주소 

(6) 기술 스택 :

• 기술스택 배지(참고)를 이용해서 기술 스택을 표현 예정.
• Environment, Development 2가지로 나눌것이다. 

(7) 화면 구성 및 사용 영상

(8) 기타내용 : 날짜 별 push한 내용을 올릴 예정

 

아 그리고 '🏠'  이런걸  'Emoji' 라고 하는줄 처음 알았다. (Emoji 찾는 사이트 링크)

 

2.  md 파일 사용 방법 : 

2.1 Headers :  

• # This is a H1 
• ## This is a H2 
• ### This is a H3 
• #### This is a H4 
• ##### This is a H5 
• ###### This is a H6

2.2. BlockQuote

• > This is a first blockqute. 
• > > This is a second blockqute. 
• > > > This is a third blockqute.

2.3. 목록

순서있는 목록(번호)

• 1. 첫번째 
• 2. 두번째 
• 3. 세번째

순서없는 목록(글머리 기호: *, +, - 지원)

* 빨강
  * 녹색
    * 파랑

+ 빨강
  + 녹색
    + 파랑

- 빨강
  - 녹색
    - 파랑

 

... 필요 할때마다 링크 따라가서 보는걸로 

 

참고 문헌 : 링크