chore: prepare package for crates.io publish#5
Merged
Conversation
Add repository/homepage links and an exclude list so the published crate ships only runtime-relevant files. Package shrinks from 59 files / 700 KiB compressed to 39 files / 199 KiB compressed. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
- Declare rust-version = "1.74" so crates.io shows a clear Rust floor. - Re-include README_CN.md in the package so the "中文文档" link in README.md resolves on the crates.io page. - Add CHANGELOG.md (Keep a Changelog format), covering 0.1.0 – 0.4.0. - README Installation section now leads with "cargo install termdown"; the pre-built install script follows for users without a Rust toolchain. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Switched from a guessed 1.74 floor to the actual toolchain in use (rustc 1.95.0). This is what every CI and developer run compiles against, so it's the only version we can honestly claim support for. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Record the follow-up to measure the real MSRV with cargo-msrv and add a CI job that pins to it. Parked for later — current 1.95 ships as-is with this PR. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Prep the repo for a first
cargo publish. All changes live inCargo.toml,README.md, and a newCHANGELOG.md— no code changes.Package metadata (
Cargo.toml)repository+homepagepointing at this GitHub repo (silences cargo's metadata warning, populates crates.io page).rust-version = "1.74"so crates.io displays a clear Rust floor. Value chosen to match the declared MSRV of our most demanding direct dep (ratatui 0.29). If we ever want a stricter/looser pin,cargo install cargo-msrv && cargo msrv findwill verify.excludelist so the tarball only ships runtime-relevant files. Excluded:CLAUDE.md,TODO.md,TEST_PLAN.md,docs/,.github/,install.sh,uninstall.sh,Cross.toml. Kept:src/,fonts/SourceSerif4-SemiBold.ttf(loaded viainclude_bytes!at build time — dropping it would breakcargo install),fixtures/,Makefile,LICENSE,README.md,README_CN.md,CHANGELOG.md.README
cargo install termdownas the recommended method.README_CN.mdstays in the package so the[中文文档](README_CN.md)link on the crates.io page resolves.CHANGELOG
CHANGELOG.mdin Keep a Changelog format, covering 0.1.0 – 0.4.0.Package size
Test plan
cargo publish --dry-runsucceeds with no warningsmake check(fmt-check + clippy + tests) passesREADME_CN.md,CHANGELOG.md,README.md,LICENSE,fonts/,fixtures/,src/all present in the package listdocs/,.github/,install.sh,CLAUDE.md,TODO.md,TEST_PLAN.mdall absent from the package listcargo login, thencargo publishfor termdown 0.4.0