Merge pull request 'docs(install): document upcoming Go-module migration + replace install command (#37)' (#1) from fix/install-path-gitea into main
This commit is contained in:
commit
51fb38e063
26
README.md
26
README.md
@ -7,13 +7,31 @@ command, or a mock for CI).
|
||||
|
||||
## Install
|
||||
|
||||
> **Migration in progress** (2026-05-07): the `github.com/Molecule-AI`
|
||||
> org was suspended on 2026-05-06 and is permanently gone. The
|
||||
> canonical SCM is now Gitea at
|
||||
> [`git.moleculesai.app/molecule-ai`](https://git.moleculesai.app/molecule-ai).
|
||||
>
|
||||
> The `go install` path below requires the Go module-path migration to
|
||||
> land first (separate cross-repo PR — see `internal#37` parked
|
||||
> follow-up). Until then, build from source:
|
||||
>
|
||||
> ```bash
|
||||
> git clone https://git.moleculesai.app/molecule-ai/molecule-cli.git
|
||||
> cd molecule-cli
|
||||
> go build -o molecule ./cmd/molecule
|
||||
> ```
|
||||
>
|
||||
> Once the Go module-path migration lands:
|
||||
|
||||
```bash
|
||||
go install github.com/Molecule-AI/molecule-cli/cmd/molecule@latest
|
||||
go install git.moleculesai.app/molecule-ai/molecule-cli/cmd/molecule@latest
|
||||
```
|
||||
|
||||
Or download a binary from [Releases](https://github.com/Molecule-AI/molecule-cli/releases).
|
||||
Releases ship Linux/macOS/Windows × amd64/arm64 archives plus a sha256
|
||||
checksums file (see `.goreleaser.yaml`).
|
||||
checksums file (see `.goreleaser.yaml`). Releases pipeline (Gitea
|
||||
Actions) is being restored as part of the post-suspension recovery; in
|
||||
the interim, build from source per the migration note above.
|
||||
|
||||
## Quick start — connect an external workspace
|
||||
|
||||
@ -78,7 +96,7 @@ molecule config view / set CLI defaults
|
||||
molecule completion generate shell completions
|
||||
```
|
||||
|
||||
The full M1 design is in [RFC #10](https://github.com/Molecule-AI/molecule-cli/issues/10).
|
||||
The full M1 design is in [RFC #10](https://git.moleculesai.app/molecule-ai/molecule-cli/issues/10) (originally filed on the suspended GitHub org; the issue may be re-filed on Gitea — check the issue tracker for the live discussion).
|
||||
|
||||
## License
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user