이 지침들은 다른 이들이 당신의 배포본을 다운로드 받고, 검색하고, 압축을 풀 때에 당신의 배포본이 어떻게 보여져야 하는지에 대해 설명한다.
초보 개발자들이 하는 가장 성가신 실수 중의 하나가 tar 파일을 배포본이 있는 현재의 디렉토리에 압축이 풀리도록 만드는 것이다. 이것은 현재 디렉토리에 이미 존재하는 파일을 덮어쓸 위험이 있다. 이런 실수를 절대로 하지마라!
그 대신, 프로젝트의 이름을 따서 만든 하나의 공통 디렉토리를 소유하는 압축 파일을 만들어 최상위 디렉토리의 바로 아래 디렉토리에 압축이 풀리도록 만들어라.
여기 makefile 트릭(trick)이 있다. `foobar'이라는 배포본의 디렉토리를 가지고 있으며 SRC가 배포본의 파일 리스트를 포함하고 있다고 가정하면 다음과 같이 하면 된다. 이렇게 하기 위해서는 GNU tar 1.13이 필요하다.
VERS=1.0
foobar-$(VERS).tar.gz:
tar --name-prefix='foobar-$(VERS)/' -czf foobar-$(VERS).tar.gz $(SRC)
만약 오래된 tar 프로그램을 가지고 있다면 이렇게 하면 된다:
foobar-$(VERS).tar.gz:
@ls $(SRC) | sed s:^:foobar-$(VERS)/: >MANIFEST
@(cd ..; ln -s foobar foobar-$(VERS))
(cd ..; tar -czvf foobar/foobar-$(VERS).tar.gz `cat foobar/MANIFEST`)
@(cd ..; rm foobar-$(VERS))
README 또는 READ.ME 파일을 포함시키면 그것은 소스 배포본의 지침서가 될 것이다. 오랜 관례에 따라 이것은 소스의 압축을 풀은 용감한 탐험가가 가장 먼저 읽어야 하는 파일이다.
README 파일에 포함되어야 할 바람직한 것들:
README 파일을 보기 전에도 당신의 용감한 탐험가(사용자)는 배포본의 최상위 디렉토리에 있는 파일들을 훑어볼 것이다. 파일의 이름은 그것 자체로 정보를 포함하고 있다. 확실한 일반적 이름 짓는 방법의 관례를 따름으로서 탐험가에게 다음에 무엇을 보아야 할지 실마리를 제공해 줄 수 있다.
여기 몇 개의 일반적인 최상위 파일 이름과 그것들이 의미하는 것이 있다. 모든 배포본이 다음 모두를 필요로 하진 않는다.
가장 먼저 읽어야 할 지침 파일
설정, 제작(build) 그리고 설치에 관한 정보
프로젝트를 지원해 주는 사람의 리스트
최근 프로젝트 소식
프로젝트 변천 과정
프로젝트 라이센서 (GNU 관습)
프로젝트 라이센서
배포본의 파일 리스트
프로젝트에 관한 `질문과 대답'의 텍스트 형식의 파일
Emacs나 vi의 사용으로 생긴 파일
사람이 읽을 수 있는 모든 패키지에 관한 정보를 포함한 파일의 이름은 모두 대문자를 사용한다는 것을 기억해 주기 바란다.