---
title: "코드 헤더 주석 → README 생성기"
url: "https://notes.junghanacs.com/notes/20250416T165145"
author: "Junghan Kim"
date: "2025-04-16T16:51:00+09:00"
lastmod: "2025-04-16T00:00:00+09:00"
tags: ["bib","comment","convert","elisp","markdown"]
description: "코드 헤더와 주석에서 README를 생성하는 도구들을 찾고 비교한 노트이다."
---

> [!abstract] 이 노트에 대하여
> 
> 코드 헤더와 주석을 Markdown README로 바꾸는 패키지와 도구들을 조사한다. 소스 코드에서 문서를 파생시키는 자동화 흐름을 고민하는 노트다.

## BIBLIOGRAPHY

- “Lindydancer/El2markdown.” 2025. <https://github.com/Lindydancer/el2markdown>.
- “Make a README.” n.d. Accessed April 16, 2025. <https://www.makeareadme.com>.
- “Mgalgs/Make-Readme-Markdown: Convert Elisp File Header Comments to Markdown Text, Suitable for a Github Readme.Md File.” n.d. Accessed April 15, 2025. <https://github.com/mgalgs/make-readme-markdown?tab=readme-ov-file>.

## 관련노트

## 히스토리

-   [2025-04-16 Wed 16:51]

### Make a README

([“Make a README” n.d.](https://notes.junghanacs.com/notes/20250416T165145#citeproc_bib_item_2))

Learn how to make a great README for your programming project, and use the editable template to get started.

### Lindydancer/el2markdown

([“Lindydancer/El2markdown” 2025](https://notes.junghanacs.com/notes/20250416T165145#citeproc_bib_item_1)) Lindgren, Anders 2025

Convert Emacs Lisp comments to MarkDown

### mgalgs/make-readme-markdown: Convert elisp file header comments to markdown text, suitable for a github README.md file

([“Mgalgs/Make-Readme-Markdown: Convert Elisp File Header Comments to Markdown Text, Suitable for a Github Readme.Md File” n.d.](https://notes.junghanacs.com/notes/20250416T165145#citeproc_bib_item_3))

## [|2025-04-16 Wed 16:51|](https://notes.junghanacs.com/journal/20250414T000000#h-2025-04-16)

@user find some packages that make 'README.md' from header and comments in codes.

@assistant 코드의 헤더와 주석을 기반으로 `README.md` 파일을 생성하는 패키지를 찾고 있다면, 다음과 같은 도구를 고려해볼 수 있습니다:

1.  **@appnest/readme**: 이 도구는 `package.json` 파일과 `blueprint.md` 파일을 사용하여 자동으로 `README.md` 파일을 생성합니다. Mustache 문법을 사용하여 `package.json` 의 정보를 README에 삽입할 수 있습니다[1].

2.  **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 이러한