Skip to content

README 문구 정리와 설치·문의 안내 개선 - #467

Merged
easygap merged 3 commits into
mainfrom
codex/readme-korean-copy-20260922
Sep 22, 2026
Merged

easygap merged 3 commits into
mainfrom
codex/readme-korean-copy-20260922

Conversation

@easygap

@easygap easygap commented Sep 22, 2026

Copy link
Copy Markdown
Owner

README의 긴 문장형 제목을 주요 기능, 보유 종목, 설치 및 실행으로 줄이고, 어려운 표현을 고쳤습니다. 첫 화면에 지원 증권사와 모의투자 여부를 적고, 설치 명령과 문의 링크를 추가했습니다.

  • 운용, 실전 전환, 최대 낙폭처럼 설명 없이 쓰던 말을 문맥에 맞게 풀었습니다. 평균 매수가·수익률처럼 주식 거래에서 흔히 쓰는 말은 유지했습니다.
  • 기존 모의투자 GIF와 계좌 사진을 사용합니다. 자동매매 상태와 모바일 사진은 펼쳐 볼 수 있습니다.
  • 설치 안내도 같은 말투로 고치고, 한국어 오류 제보·기능 제안 양식을 추가했습니다.
  • 저장소 소개에 Python과 한국투자증권 KIS API를 명시했습니다. 실제 지원 기능에 맞춰 etf, portfolio-rebalancing, stock-trading 주제 태그를 추가했습니다.

참고 자료

2026년 9월 22일 기준으로 확인한 공개 자료입니다. 글의 발행일과 확인일을 구분합니다.

확인

  • README와 설치 안내의 상대 링크·이미지 경로 24개 확인
  • PowerShell 명령 8개 블록 문법 확인
  • 문의 양식 2개 YAML 문법·필수 항목 확인
  • GIF와 PNG 파일 정상 확인
  • GitHub 실제 페이지에서 320px·390px·1280px 확인: 이미지 정상, README 본문 가로 넘침 없음, 접기/펼치기와 설치 위치 이동 정상
  • 모바일에서 표의 첫 열이 한 글자씩 나뉘는 문제를 확인해 기능 목록으로 변경
  • GitHub 검색에서 KIS 소개 검색과 etf 주제 검색으로 저장소가 조회되는 것 확인
  • 최종 커밋의 GitHub Actions 검사 통과: 2,058개 테스트 통과

@easygap
easygap merged commit 9fd86f2 into main Sep 22, 2026
1 check passed
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