From 29482fd85a46faa0100c4da3f4abda50a2951ead Mon Sep 17 00:00:00 2001 From: Paul d'Aoust Date: Wed, 13 Nov 2024 13:56:57 -0800 Subject: [PATCH] update holonix commands to get recommended version --- src/pages/get-started/install-advanced.md | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/src/pages/get-started/install-advanced.md b/src/pages/get-started/install-advanced.md index 5740e799d..d793ebd67 100644 --- a/src/pages/get-started/install-advanced.md +++ b/src/pages/get-started/install-advanced.md @@ -22,15 +22,22 @@ If you want to learn more about how this setup works and how to create it manual The flake-based one-liner to get you an ad-hoc Holonix shell looks like this: ```shell -nix develop github:holochain/holonix +nix develop github:holochain/holonix?ref=main-0.3 ``` -The above one-liner will give you the latest version of Holochain from branch `main`. To get an ad-hoc shell with a specific version of Holochain, use the flag `--override-input versions `. +The above one-liner will give you the latest version of the **recommended** Holochain 0.3 release branch. To get an ad-hoc shell with a specific version of Holochain, change the `ref` parameter, for example: ```shell -nix develop --override-input holochain "github:holochain/holochain?ref=main-0.4" github:holochain/holonix +nix develop github:holochain/holonix?ref=main-0.4 ``` +The options you should know about are: + +* `main` or no `ref` parameter: Bleeding-edge development version of Holochain (currently 0.5) +* `main-0.4`: RC of Holochain 0.4 (be aware that many breaking changes are coming in the next RC) +* `main-0.3`: The current recommended version of Holochain for everyday development +* `main-0.2`: An older version of Holochain, no longer recommended + ### A gotcha with Flakes and Git The behavior of `nix` commands that rely on a `flake.nix` as its input such as `nix develop` can be counterintuitive in a git repository.