Skip to content

[Docs] README 를 4.1.0 화면으로 다시 쓴다 - #281

Merged
KiSeungMin merged 6 commits into
developfrom
docs/readme-renewal
Sep 24, 2026
Merged

KiSeungMin merged 6 commits into
developfrom
docs/readme-renewal

Conversation

@KiSeungMin

@KiSeungMin KiSeungMin commented Sep 24, 2026 •

Copy link
Copy Markdown
Contributor

✔️ 연관 이슈

  • 없습니다. 문서 작업이라 이슈 없이 진행했습니다.

📝 작업 내용

예전 화면과 글만 있던 README 를, 앱 소개 페이지에 가깝게 다시 썼습니다. 처음 보는 사람이 스크롤만 내려도 이 앱이 무엇을 해 주는지 보이는 것을 목표로 했습니다.

  • 첫 화면을 새로 만들었습니다. 로고와 한 줄 소개, 스토어와 가이드 배지, 기기 세 대를 붙인 히어로 이미지를 올렸습니다.
  • 스크린샷 51장을 새로 찍어 넣었습니다. 이번 4.1.0 화면이고, 시뮬레이터 창을 그대로 찍는 대신 Xcode 의 기기 프레임을 3배 해상도로 합성해서 만들었습니다.
  • 4.1.0 새 기능을 앞으로 뺐습니다. 옷장, 꾸미기, 미션, 훈장, 카메라 개선을 한 절로 묶었습니다.
  • 개발자용 내용을 더했습니다. 기술 스택, lib/ 구조, 실행과 검증 명령(--dart-define=ENV=dev, flutter analyze, flutter test)입니다.
  • 업데이트 내역에서 서비스 중지와 재개 줄을 뺐습니다. 표도 날짜, 버전, 내용 세 칸으로 정리했습니다.

이미지를 어디에 둘지

docs/ 는 .gitignore 에 있고 assets/ 는 앱 번들에 들어가서, 둘 다 README 이미지 자리로 맞지 않았습니다. 그래서 .github/readme/ 에 두었습니다. 폭 420px 로 줄여 51장 합쳐 2.8MB 입니다.

파일명을 영문으로 지은 이유

맥에서 만든 한글 파일명은 자모가 분해된 형태(NFD)로 저장되는데, README 에 적는 경로는 합쳐진 형태(NFC)라 GitHub 에서 이미지가 깨집니다. 처음에 한글 이름으로 넣었다가 이걸 발견해서 01-login.png, 38-closet.png 처럼 영문으로 바꿨습니다.

스크린샷 (선택)

README 첫 화면입니다.

🙏 리뷰 요청 및 전달사항

봐주셨으면 하는 곳입니다.

  • 기술 스택 표: pubspec.yaml 을 보고 적었는데, "앱 버전 헤더와 토큰 재발급을 거치는 자체 HttpService" 처럼 제가 해석해 쓴 줄이 있습니다. 실제와 다르면 알려 주세요.
  • 문구: 기능 설명을 전부 다시 썼습니다. 스토어 소개문과 톤이 어긋나는 곳이 있으면 맞추겠습니다.

전달사항입니다.

  • 업데이트 내역의 날짜는 년과 월까지만 적었습니다. 일까지 적으면 출시일이 밀릴 때마다 문서를 고쳐야 해서, 지난 버전들도 같은 규칙으로 맞췄습니다.
  • 코드 변경은 없습니다. README 와 이미지 파일만 바뀝니다.

…에 새로 찍은 4.1.0 스크린샷 50장을 기능마다 표로 넣고 첫 화면에 기기 세 대를 붙인 히어로 이미지를 둔다, 옷장과 미션 훈장 카메라 개선을 따로 묶어 앞에 두고 기술 스택과 프로젝트 구조 개발 환경 세팅을 더한다, 이미지는 앱 번들에 안 들어가는 .github/readme 에 두고 파일명을 영문으로 지어 맥에서 만든 한글 파일명이 깨지는 것을 막는다, 업데이트 내역에서 서비스 중지와 재개 줄은 뺀다
…라 달라져 사진마다 높이가 어긋났다, 모든 스크린샷을 170 너비로 통일하고 스터디룸 여섯 장은 세 장씩 두 줄로 나눈다, 맨 위 개구리 사진은 바로 아래 히어로 이미지와 겹쳐 빼고 쓰지 않게 된 파일도 지운다, 배지는 스토어와 가이드를 큰 버튼으로 버전과 기술은 작은 사각으로 나눠 높낮이가 들쭉날쭉하던 것을 없앤다
…트 목록과 방식 고르기, 집중 복습 추천을 빼 모든 줄을 네 장으로 맞춘다, 화면이 없어 빈 칸이던 기기 연동 행은 같은 이야기가 위 표에 있어 지운다, 2024년 업데이트 일곱 줄은 접어 두고 쓰지 않게 된 이미지 세 장도 지운다
…으니 읽는 흐름이 끊긴다, 개발에 필요한 내용은 CLAUDE.md 와 AGENTS.md 에 이미 있어 기술 스택만 남긴다
@KiSeungMin
KiSeungMin merged commit bc62384 into develop Sep 24, 2026
1 check passed
@KiSeungMin
KiSeungMin deleted the docs/readme-renewal branch September 24, 2026 15:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant