Summary
The project supports three install channels (self-contained shell script, NuGet global tool, and implicit Docker / manual container builds), but there is no consolidated comparison document explaining their trade-offs, prerequisites, update mechanisms, or planned roadmap (homebrew, winget, apt, rpm, Snap, Flatpak). README.md:40-47 shows only install.sh. USER_GUIDE.md:131-165 lists options A and B but not how to choose between them or what happens when both are installed side-by-side.
Where
README.md:40-47 (Quick Start shows install.sh only)USER_GUIDE.md:131-165 (Options A and B documented separately)- No
DISTRIBUTION.md / CHANNELS.md collating the matrix
Suggested approach
- Create
DISTRIBUTION.md at repo root documenting every supported channel: install.sh, NuGet global tool, container builds, and planned (homebrew, winget, apt, rpm).
- For each channel, document platform support, prerequisites, update path, offline capability, and lifecycle policy.
- Add a decision matrix table to
USER_GUIDE.md comparing all channels.
- Link
DISTRIBUTION.md from README.md Documentation section.
- Clarify in
INTEGRATION_POLICY.md and COMMERCIAL_LICENSE.md whether third-party package maintainers may distribute the binary.
- Add a contributor checklist in
DEVELOPER_GUIDE.md for each release: which artifacts to verify per channel.
Summary
The project supports three install channels (self-contained shell script, NuGet global tool, and implicit Docker / manual container builds), but there is no consolidated comparison document explaining their trade-offs, prerequisites, update mechanisms, or planned roadmap (homebrew, winget, apt, rpm, Snap, Flatpak).
README.md:40-47shows onlyinstall.sh.USER_GUIDE.md:131-165lists options A and B but not how to choose between them or what happens when both are installed side-by-side.Where
README.md:40-47(Quick Start shows install.sh only)USER_GUIDE.md:131-165(Options A and B documented separately)DISTRIBUTION.md/CHANNELS.mdcollating the matrixSuggested approach
DISTRIBUTION.mdat repo root documenting every supported channel: install.sh, NuGet global tool, container builds, and planned (homebrew, winget, apt, rpm).USER_GUIDE.mdcomparing all channels.DISTRIBUTION.mdfromREADME.mdDocumentation section.INTEGRATION_POLICY.mdandCOMMERCIAL_LICENSE.mdwhether third-party package maintainers may distribute the binary.DEVELOPER_GUIDE.mdfor each release: which artifacts to verify per channel.