Skip to content

feat: rewrite SKILL.md, enhance README install section, add CI workflow - #1

Merged
neipor merged 2 commits into
masterfrom
copilot/update-skill-installation-instructions
Apr 4, 2026
Merged

feat: rewrite SKILL.md, enhance README install section, add CI workflow#1
neipor merged 2 commits into
masterfrom
copilot/update-skill-installation-instructions

Conversation

Copilot AI commented Apr 4, 2026

Copy link
Copy Markdown
Contributor

Overhauls the skill definition, installation documentation, and CI/CD setup. The previous SKILL.md was sparse, README install instructions were incomplete (no PATH guidance, no Windows automation), and there was no CI workflow for validating PRs.

skill/SKILL.md

  • Enriched front-matter: added tags, switched install kind to release, expanded env-var descriptions
  • Added full internals walkthrough (upload → queue → SSE stream → ZIP extract → format)
  • Four install paths with copy-paste commands: one-liner curl (macOS Universal / Linux x86_64 / ARM64), Windows PowerShell with automatic PATH registration, cargo build --release, cargo install
  • PATH tips for rootless installs ($HOME/.local/bin)
  • Complete option reference with per-flag explanations
  • Grouped examples: basic, file output, LLM pipes, advanced (proxy, VLM backend, PPTX)
  • Output format samples (Markdown with LaTeX, JSON schema, plain text)
  • Limits/performance table; backend comparison table with use-case guidance

README.md

  • Added CI / Release / version / MIT badges
  • Replaced vague "download from Releases" with curl | tar one-liners placing binary directly in /usr/local/bin/
  • Windows PowerShell script: versioned download → extract → %LOCALAPPDATA%\Programs\mineru → permanent user PATH update
  • cargo install and source-build-to-PATH options
  • Expanded binary table with architecture column

.github/workflows/ci.yml (new)

  • Triggers on push/PR to main/master
  • Three jobs: rustfmt check, clippy (-D warnings), build + test (matrix: ubuntu / macos / windows)
  • Cargo registry cache; permissions: contents: read

.github/workflows/release.yml

  • skill/SKILL.md now bundled in every release archive (.tar.gz and .zip)

@neipor
neipor marked this pull request as ready for review April 4, 2026 04:37
@neipor
neipor merged commit 8fe178d into master Apr 4, 2026
1 of 6 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.

2 participants