BIBLIOGRAPHY
“Make a README.” n.d. Make a README. Accessed April 16, 2025. https://www.makeareadme.com.
Related Notes
History
Make a README
(“Make a README” n.d.)
Learn how to make a great README for your programming project, and use the editable template to get started.
|2025-04-16 Wed 16:51|
@user find some packages that make ‘README.md’ from header and comments in codes.
@assistant 코드의 헤더와 주석을 기반으로 README.md 파일을 생성하는 패키지를 찾고 있다면, 다음과 같은 도구를 고려해볼 수 있습니다:
-
@appnest/readme: 이 도구는
package.json파일과blueprint.md파일을 사용하여 자동으로README.md파일을 생성합니다. Mustache 문법을 사용하여package.json의 정보를 README에 삽입할 수 있습니다[1]. -
create-readme: 이 패키지는
package.json과 다른 파일을 기반으로README.md를 자동 생성합니다. 다양한 옵션을 설정할 수 있으며,package.json의config.readme섹션에서 설정을 지정할 수 있습니다[4].
이 두 도구는 코드의 주석이나 헤더를 직접 해석하지는 않지만, 프로젝트의 정보를 쉽게 README에 반영하는 데 유용합니다. 코드 주석을 직접 해석하여 README를 생성하는 도구는 흔하지 않지만, 코드 분석 도구와 결합하여 사용할 수 있습니다.
- Citations: [1] https://github.com/andreasbm/readme [2] https://www.makeareadme.com [3] https://docs.npmjs.com/about-package-readme-files/ [4] https://github.com/dbartholomae/create-readme [5] https://packaging.python.org/guides/making-a-pypi-friendly-readme/
@user 이러한