엑셀 합치기·파일 이름 바꾸기처럼 하고 싶은 일을 적으면 처음 써도 돌아가는 파이썬 코드와 설치·실행 순서를 줍니다. 지우거나 덮어쓰는 일은 하지 않게 해요.
프로젝트에 대해 아는 것을 적으면 깃허브 README 초안을 섹션별로 씁니다. 적지 않은 기능·명령·라이선스는 지어내지 않고 「확인 필요」로 남겨요.
당신은 오픈소스 문서를 많이 써 본 개발자입니다. 제 프로젝트의 README.md 초안을 마크다운으로 써 주세요. 처음 온 사람이 1분 안에 「무엇이고, 어떻게 써 보나」를 알 수 있게 하는 것이 목표입니다. 지킬 것 - 제가 적은 사실만 쓰세요. 적지 않은 기능, 설치 명령, 지원 환경, 숫자, 라이선스는 지어내지 말고 「확인 필요」로 남기세요. - 명령어는 코드 블록에 넣고, 복사해서 그대로 돌릴 수 있게 쓰세요. - 비밀값(API 키, 토큰)은 예시에도 진짜처럼 쓰지 말고 「여기에 내 키」처럼 자리만 표시하세요. - 문장은 짧게 쓰고, 자랑하는 말(최고의, 혁신적인)은 빼고 하는 일을 쓰세요. 섹션 순서 1. 이름과 한 줄 소개 2. 무엇을 해 주나: 기능 3~5개 3. 화면: 스크린샷이나 GIF 자리(파일 이름만) 4. 시작하기: 필요한 것 → 설치 → 처음 실행 5. 사용법: 자주 쓰는 예 두세 개 6. 설정: 환경 변수 표(이름 / 뜻 / 예시 자리) 7. 자주 묻는 질문 2~3개 8. 기여하는 법과 라이선스(제가 적은 대로, 없으면 「확인 필요」) 그리고 따로 - 제가 영어도 원하면 같은 구조로 영어판 - 제가 직접 채우거나 확인할 것 목록 정보가 모자라면 지어내지 말고 그 자리를 「확인 필요」로 남긴 채 먼저 써 주세요. 그리고 끝에, 무엇을 더 알려 주면 좋아지는지 한 줄로 물어보세요. 내 프로젝트 - 이름: [프로젝트 이름] - 무엇을 하나: [한두 줄 설명] - 기술: [언어·프레임워크·버전] - 설치·실행 방법: [아는 명령어] - 기능: [기능 목록] - 필요한 설정: [환경 변수·키 이름] - 라이선스: [예: MIT, 모르면 비우기] - 언어: [한국어 / 영어 / 둘 다]
[프로젝트 이름][한두 줄 설명][언어·프레임워크·버전][아는 명령어][기능 목록][환경 변수·키 이름][예: MIT, 모르면 비우기][한국어 / 영어 / 둘 다]- 이름: 오늘메모(todaymemo) - 무엇을 하나: 터미널에서 한 줄로 할 일과 메모를 적고, 날짜별로 모아 보는 명령줄 도구(예시용 가상 프로젝트) - 기술: 파이썬 3.11, 표준 라이브러리만, 데이터는 내 컴퓨터의 JSON 파일 하나 - 설치·실행 방법: 설치는 pipx install todaymemo, 추가는 memo add "장 보기", 목록은 memo list - 기능: 한 줄 추가, 오늘·이번 주 목록, 완료 표시, 마크다운으로 내보내기 - 필요한 설정: TODAYMEMO_HOME(저장 폴더, 없으면 홈 폴더) - 라이선스: MIT - 언어: 한국어
README.md 초안입니다. 적어 주신 내용만 썼고, 모르는 자리는 「확인 필요」로 남겼습니다.
# 오늘메모 (todaymemo)
터미널에서 할 일과 메모를 한 줄로 적고, 날짜별로 모아 보는 명령줄 도구입니다.
> 예시용 가상 프로젝트입니다.
## 기능
- 할 일이나 메모를 한 줄로 추가합니다.
- 적은 것을 날짜별로 모아 오늘 목록, 이번 주 목록으로 보여 줍니다.
- 끝낸 할 일에 완료 표시를 합니다.
- 적은 내용을 마크다운으로 내보냅니다.
- 데이터는 내 컴퓨터의 JSON 파일 하나에 저장합니다.
## 화면
## 시작하기
### 필요한 것
- 파이썬 3.11 (다른 버전에서 되는지: 「확인 필요」)
- pipx (설치 방법: 「확인 필요」)
- 운영체제: 「확인 필요」
파이썬 표준 라이브러리만 씁니다. 따로 설치할 패키지는 없습니다.
### 설치
```bash
pipx install todaymemo
```
설치하면 `memo` 명령을 쓸 수 있습니다.
### 처음 실행
할 일을 하나 적고, 목록을 봅니다.
```bash
memo add "장 보기"
memo list
```
목록에 `장 보기`가 보이면 됩니다. 출력 예시: 「확인 필요」
## 사용법
### 할 일 적기
```bash
memo add "회의 자료 보내기"
```
### 목록 보기
```bash
memo list
```
오늘 목록과 이번 주 목록을 골라 보는 방법: 「확인 필요」
### 완료 표시하기
명령: 「확인 필요」
## 설정
| 이름 | 뜻 | 예시 |
| --- | --- | --- |
| `TODAYMEMO_HOME` | 데이터를 저장할 폴더입니다. 정하지 않으면 홈 폴더를 씁니다. | `여기에 저장 폴더 경로` |
## 자주 묻는 질문
### 데이터는 어디에 저장되나요?
내 컴퓨터의 JSON 파일 하나에 저장합니다. 파일은 `TODAYMEMO_HOME` 폴더에 둡니다. 정하지 않으면 홈 폴더에 둡니다. 파일 이름: 「확인 필요」
### 적은 내용을 다른 문서로 옮길 수 있나요?
마크다운으로 내보낼 수 있습니다. 명령: 「확인 필요」
## 기여와 라이선스
- 기여하는 법: 「확인 필요」
- 라이선스: MIT
언어를 한국어로 적어 주셔서 만들지 않았습니다. 필요하면 같은 구조로 만들겠습니다.
demo.gif 찍어 넣기(할 일을 적고 목록을 보는 모습)pipx install todaymemo로 실제로 설치되는지, 설치 뒤 바로 memo가 실행되는지memo list 실행 결과(오늘 것만 나오는지, 전체가 나오는지)LICENSE 파일이 있는지(저작권자 이름과 연도)완료 표시·이번 주 목록·마크다운 내보내기 명령과 memo list 실행 결과를 알려 주시면 사용법의 빈칸을 채울 수 있는데, 알려 주시겠어요?
위 예시 입력으로 이 프롬프트를 AI(Claude)에 그대로 넣어 받은 답이에요. 모델과 시점에 따라 표현은 달라질 수 있어요.
무엇인지(한 줄 소개), 어떻게 설치하고 처음 돌리는지, 자주 쓰는 사용 예 두세 가지가 가장 중요해요. 나머지는 프로젝트가 커지면서 채워도 돼요.
국내 사용자만 보면 한국어로 충분하고, 해외 개발자도 보길 바라면 영어판을 같이 두세요. 「언어」 칸에 「둘 다」라고 적으면 같은 구조로 두 벌을 써 줘요.
README는 저장소에 온 사람을 위한 문서라, 사람을 데려오는 일은 따로 해야 해요. 개인이 만든 서비스를 모아 소개하는 드림보트에 올리면 버전마다 기록이 남고 앱·서비스 소개 글도 따로 써 줘요.
「확인 필요」로 남은 곳을 채우고, 설치 명령을 새 폴더에서 처음부터 따라 해 보고 올리세요. 적은 대로 안 되면 README가 오히려 사람을 돌려보내요.
드림보트에 프로젝트를 올리면 저희가 대신 홍보해 드려요. 물론 무료예요.