Skip to content

docs: update README installation section with platform-specific scripts (#74)#75

Merged
q-soriarty merged 1 commit intodevelopfrom
docs/74-update-readme-install-section
Mar 27, 2026
Merged

docs: update README installation section with platform-specific scripts (#74)#75
q-soriarty merged 1 commit intodevelopfrom
docs/74-update-readme-install-section

Conversation

@q-soriarty
Copy link
Copy Markdown
Contributor

@q-soriarty q-soriarty commented Mar 27, 2026

Summary

  • Replace manual mkdir + cp with clone + install script for Linux, macOS, and Windows
  • Add uninstall instructions for all platforms
  • Keep manual symlink method as fallback
  • Explain symlink advantage (auto-sync with repo)

Closes #74

Test plan

  • Linux install instructions reference install_linux.sh
  • macOS install instructions reference install_macos.sh
  • Windows install instructions reference install_windows.ps1
  • Uninstall section covers all 3 platforms
  • Manual fallback uses symlink (not cp)

Replace manual cp with clone + install script instructions for
Linux, macOS, and Windows. Add uninstall and manual fallback sections.
@q-soriarty q-soriarty merged commit d8e9b37 into develop Mar 27, 2026
@q-soriarty q-soriarty deleted the docs/74-update-readme-install-section branch March 27, 2026 22:54
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