Repository navigation
First release on crates.io
wiki-reader is now on crates.io. The package is wiki-reader-tui (the name wiki-reader was taken); the installed command is still wiki-reader.
cargo install --locked wiki-reader-tui
# lite build (no images, SVG or Mermaid pictures; smaller and faster to build)
cargo install --locked --no-default-features wiki-reader-tuiIf you installed wiki-reader before the rename, run cargo uninstall wiki-reader first (or add --force): cargo will not let a second package overwrite the same command. Tags up to v0.1.10 install under the old package name. The library crates wiki-reader-core, wiki-reader-media and wiki-reader-render are published alongside it.
What changed since v0.1.10
- Packaging. MSRV 1.92 (checked in CI), a
cargo-denypolicy and CI job,NOTICE, per-crate licence copies, andTHIRD-PARTY-LICENSESin every release tarball. SECURITY.md points at GitHub private vulnerability reporting. - Releases.
v0.1.*tags are no longer flagged as GitHub prereleases; only tags with a suffix (-rc.1) are. The project is pre-1.0: only the latest release gets fixes. - Docs. Table, diagram and image viewer screenshots in the UI spec; all screenshots live in
wiki/assets/. - Tooling. The orphaned-reader PTY check is now a Rust tool (
check-orphan-exit) and gains a case for a reader whose terminal never reads its output. The macOS "stateE" report (V23) could not be reproduced and was dropped. - Dependencies.
signal-hook0.4,toml1.x,mermaid-text0.57,instaand the GitHub actions.
There are no behaviour changes to the reader itself.
Install and upgrade
Download the matching platform tarball and its .sha256, verify the checksum, and replace the binary in the same install location. See Releasing and upgrading.
- Binaries are unsigned and not notarized.
- Browser downloads on macOS may be quarantined. If Gatekeeper blocks the extracted binary, run
xattr -d com.apple.quarantine path/to/wiki-reader. - The Linux binary links the glibc from the
ubuntu-latestbuild runner; older distributions may needcargo install. - Upgrades preserve configuration and saved sessions.