Skip to content

docs(readme): reorganize the README around install, features and Hangul fidelity - #557

Merged
airmang merged 2 commits into
mainfrom
docs/readme-refresh
Oct 24, 2026
Merged

airmang merged 2 commits into
mainfrom
docs/readme-refresh

Conversation

@airmang

@airmang airmang commented Oct 24, 2026

Copy link
Copy Markdown
Owner

Rewrites README.md and README_EN.md together.

  • Order: one-line pitch → getting started → what it does → how close to Hangul → where you can run it (ChatGPT included) → comparison → known limitations.
  • What it does now covers HWP 5.0 read/write, FormFit, table structure editing and doc.tables[i], and the experimental estimate_pages / write_line_caches (including the other-viewer case from [Bug] .hwp 저장 시 그림 문단에 PARA_LINE_SEG 가 없어 다른 렌더러(rhwp)가 그림을 그리지 못한다 #550).
  • "How close to Hangul": layout figures measured with Hancom Office 2024 on 2026-10-24 (public documents' line breaks, page-count estimates over 1,382 documents with their make-up stated), followed by the earlier open-rate figures with their dates and versions.
  • Development status: Beta (README and the Development Status classifier). The stable surface is linked.
  • Kept verbatim because tests pin them: the three-repo table and the [visual] extra note. The other projects' cells in the comparison table are unchanged.
  • docs/python-example-ledger.json regenerated for the new manual hashes (code fences unchanged).

🤖 Generated with Claude Code

airmang and others added 2 commits October 24, 2026 22:35
…ul fidelity

Lead with installing and a first example, list what the library does today
(HWP 5.0 read and write, FormFit, table structure editing, the experimental
page estimate and line caches), and replace the old "measured" section with
layout figures from Hancom Office 2024, keeping the earlier open-rate figures
with their dates. The ChatGPT walkthrough moves under "Where you can run it".
Development status becomes Beta, in the README and the package classifiers.
Both README_EN.md and README.md change together.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The page-count row now counts estimates made from a copy without line
layout data, compared with the page count of the Hangul that saved each
document, and the table names that reference next to every figure.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@airmang
airmang merged commit 1fed0b8 into main Oct 24, 2026
13 checks 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