README 문서에는 이런 것들이 들어가야 합니다.
프로젝트 이름 v1.0
WHAT IS THIS?
여기에는 이 소스코드가 어떤 일을 하는지 씁니다.
ON WHAT HARDWARE DOES IT RUN?
여기에는 하드웨어 종속성에 대해서 씁니다.
DOCUMENTATION:
여기에는 이 프로젝트 문서들이 어디에 있는지 무엇을 설명하는지 쓰는 것 같습니다 :-)
INSTALLING the source:
여기에는 소스코드를 설치하는 방법에 대해서 씁니다.
SOFTWARE REQUIREMENTS:
여기에는 소프트웨어 종속성에 대해서 씁니다. 빌드하는데 필요한 라이브러리라던지..
CONFIGURING:
여기에는 configure하는 방법에 대하여 씁니다. autotool을 사용해야 한다던지 cmake를 사용한다던지..
COMPILING:
여기에는 컴파일 하는 방법을 씁니다. make, make clean, 혹은 다른 make *** 명령에 대해서 쓰면 될 것 같습니다.
WHAT IS THIS?
여기에는 이 소스코드가 어떤 일을 하는지 씁니다.
ON WHAT HARDWARE DOES IT RUN?
여기에는 하드웨어 종속성에 대해서 씁니다.
DOCUMENTATION:
여기에는 이 프로젝트 문서들이 어디에 있는지 무엇을 설명하는지 쓰는 것 같습니다 :-)
INSTALLING the source:
여기에는 소스코드를 설치하는 방법에 대해서 씁니다.
SOFTWARE REQUIREMENTS:
여기에는 소프트웨어 종속성에 대해서 씁니다. 빌드하는데 필요한 라이브러리라던지..
CONFIGURING:
여기에는 configure하는 방법에 대하여 씁니다. autotool을 사용해야 한다던지 cmake를 사용한다던지..
COMPILING:
여기에는 컴파일 하는 방법을 씁니다. make, make clean, 혹은 다른 make *** 명령에 대해서 쓰면 될 것 같습니다.
사실 이건 리눅스 커널의 README 파일의 내용 중 제목만 추려본 것입니다.
심플하면서도 멋진 구성입니다.