Skip to content

docs: restructure install paths around user intent (WIP) - #599

Draft
viniciusdc wants to merge 1 commit into
mainfrom
docs/pixi-install-paths-563
Draft

docs: restructure install paths around user intent (WIP)#599
viniciusdc wants to merge 1 commit into
mainfrom
docs/pixi-install-paths-563

Conversation

@viniciusdc

Copy link
Copy Markdown
Contributor

Part of #563.

What

Restructures the README install section around user intent instead of leading with "build from source":

  • pixi (recommended) - project-scoped pixi add that pins in pixi.lock, plus pixi global install.
  • Homebrew cask for macOS.
  • Release archives with the cosign-signature + checksum verification steps spelled out.
  • From source moved to a contributor-facing subsection, and the Go 1.26+ prerequisite scoped to it (end users no longer need a Go toolchain).

Draft / incomplete - do not merge yet

Opening as a draft on purpose. Outstanding:

Holding here until #579 and #539 settle so this documents reality rather than intent.

Reorganize the README install section by how people actually install nic:
pixi (recommended, pending the prefix.dev channel), Homebrew, release
archives with signature verification, and from-source for contributors.
Scope the Go 1.26+ prerequisite to source builds only.

Draft: the pixi path depends on #579, the install-script and Homebrew
sections overlap #539, and the docs-site mirror is still pending.

Part of #563.
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