[프로보노 프로젝트] GitHub README.md 작성

내가 맡은 부분(전처리와 엔진)은 90%정도 개발이 완료되어 깃허브에 COMMIT을 해두었다. 우리의 프로젝트를 모르는 사람도 잘 이해할 수 있게 README도 작성하고싶은데 어떤 내용이 들어가면 좋을지 몰라서 이것저것 찾아보았다. 찾아본 자료들을 백업해둔다. 

 

1. 간단한 Markdowm 예시

## Markdown

소스코드 블록은 다음과 같이 작성할 수 있습니다.

```c
#include <stdio.h>

int main(void) {
  printf("Hello World!");
  return 0;
}
```

링크는 다음과 같이 작성할 수 있습니다.

[블로그 주소](https://cordingdiary.tistory.com/)

순서 없는 목록은 다음과 같이 작성할 수 있습니다.

* 깃 튜토리얼
  * 깃 Clone
  * 깃 Pull
  * 깃 Commit
    * 깃 Commit 1)
    * 깃 Commit 2)

인용 구문은 다음과 같이 작성할 수 있습니다.

> 'make it count.'-TiTanic- 

테이블은 다음과 같이 작성할 수 있습니다.

이름|영어|정보|수학
---|---|---|---|
강슬기|98점|87점|100점|
신류진|97점|78점|93점|
한소희|89점|93점|97점|

강조는 다음과 같이 할 수 있습니다.

**이부분이 강조!** 됩니다

 

2. 참고 해 볼 만한 Git README

README 예시를 찾다보니 깃허브에 올려져있는 여러가지 프로젝트 리드미들을 볼 수 있었다. 다음은 좋은 README들을 모아놓은 repo이다.

https://github.com/matiassingers/awesome-readme

GitHub - matiassingers/awesome-readme: A curated list of awesome READMEs

https://github.com/RichardLitt/standard-readme/blob/master/spec.md#specification

GitHub - RichardLitt/standard-readme: A standard style for README files

이건 README에 들어가면 좋을 내용을 템플릿 형식으로 모아놓은 repo이다. 프로젝트의 특성에 따라 선택적으로 참고하면 좋을 것 같다. 

 

3. Markdown Editor

깃허브에서는 마크다운을 바로바로 확인하기가 어려워서 따로 에디터에서 편집한 후 깃허브에 copy & paste를 하는 방법이 더 편했다. 내가 사용했던 에디터를 추천한다! 

https://stackedit.io/app#

StackEdit

 

4. 내가 작성한 README 

##Description

프로젝트에 대한 간단한 설명 기술
간결하고 명료하게 작성하는 것이 좋다.
프로젝트의 가치 전달

 

##Environment
실행환경에 대해 작성
OS, 컴파일러, CPU나 RAM 

 

##Prerequisite
실행하기 전 설치해야 할 pakage

 

##Files
각 파일들이 어떤 역할을 하는지

 

##Usage
작성한 코드들을 어떻게 실행해야 하는지 가이드라인 

 

의 목차에 따라 작성했다. 완성본은 다음과 같다.

전체 내용은 여기(https://github.com/am1wr0ng/2021-Probono-Project/blob/main/README.md)에서 확인할 수 있다.

 

README는 한번에 다 적는 게 아니라 프로젝트를 수행하면서 조금씩 추가하는 거라고 한다. 아직 스니핑을 구현하지 않았으니 후에 더 수정하는 과정을 거쳐야겠다. 

 

프로젝트가 마무리 되어가는 것 같아 기쁘다. 끝까지 잘 마무리 할 수 있었으면 좋겠다!