From a12d7e1115c7207f75f9e046d547c7a33817c62e Mon Sep 17 00:00:00 2001 From: Zhaofeng Li Date: Tue, 7 Dec 2021 23:13:31 -0800 Subject: [PATCH] Update installation docs to point users at Nixpkgs Nixpkgs now includes Colmena starting with 21.11 and is now the preferred method to obtain Colmena. The `stable` branch will continue to be updated for each stable release. Fixes #41. --- README.md | 8 +++++--- manual/src/tutorial/flakes.md | 14 ++++---------- manual/src/tutorial/index.md | 6 ++++-- 3 files changed, 13 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index d08aa7f..482e7b9 100644 --- a/README.md +++ b/README.md @@ -25,15 +25,17 @@ $ colmena apply --on @tag-a ## Installation -To install the latest stable version to the user profile, use the following command: +`colmena` is included in Nixpkgs beginning with 21.11. + +Use the following command to enter a shell environment with the `colmena` command: ```bash -nix-env -if https://github.com/zhaofengli/colmena/tarball/stable +nix-shell -p colmena ``` ### Unstable Version -To install the latest development version: +To install the latest development version to your user profile: ```bash nix-env -if https://github.com/zhaofengli/colmena/tarball/main diff --git a/manual/src/tutorial/flakes.md b/manual/src/tutorial/flakes.md index 80c875c..dc3130c 100644 --- a/manual/src/tutorial/flakes.md +++ b/manual/src/tutorial/flakes.md @@ -3,20 +3,14 @@ ## Installation -To quickly try Colmena out, use the following command to enter an ephemeral environment with the latest stable version of `colmena`: +`colmena` is included in Nixpkgs beginning with 21.11. + +For this tutorial, use the following command to enter an ephemeral environment with the `colmena` command: ```bash -nix shell github:zhaofengli/colmena/stable +nix shell nixpkgs#colmena ``` -To install Colmena to the user profile, use the following command: - -```bash -nix-env -if https://github.com/zhaofengli/colmena/tarball/stable -``` - -You can also add `github:zhaofengli/colmena/stable` as an input in your Flake and add the `colmena` package to your `devShell`. - If you are interested in trying out the bleeding-edge version of Colmena, Read [the unstable version](https://zhaofengli.github.io/colmena/unstable) of the Manual for instructions. diff --git a/manual/src/tutorial/index.md b/manual/src/tutorial/index.md index a94b9c1..5ccc766 100644 --- a/manual/src/tutorial/index.md +++ b/manual/src/tutorial/index.md @@ -4,10 +4,12 @@ -To install the latest stable version to the user profile, use the following command: +`colmena` is included in Nixpkgs beginning with 21.11. + +For this tutorial, use the following command to enter an ephemeral environment with the `colmena` command: ```bash -nix-env -if https://github.com/zhaofengli/colmena/tarball/stable +nix-shell -p colmena ``` If you are interested in trying out the bleeding-edge version of Colmena, Read [the unstable version](https://zhaofengli.github.io/colmena/unstable) of the Manual for instructions.