DGNum/colmena
12
0
Fork 1
Code Issues 6 Pull requests 2 Projects Releases Packages Wiki Activity

Update installation docs to point users at Nixpkgs

Browse source 
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.
This commit is contained in:
Zhaofeng Li 2021-12-07 23:13:31 -08:00
parent 83ebe45f20
commit a12d7e1115
3 changed files with 13 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -25,15 +25,17 @@ $ <b>colmena apply --on @tag-a</b>
## 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

14
manual/src/tutorial/flakes.md
View file

@ -3,20 +3,14 @@
## Installation
<!-- STABLE_BEGIN -->
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.
<!-- STABLE_END -->

6
manual/src/tutorial/index.md
View file

@ -4,10 +4,12 @@
<!-- STABLE_BEGIN -->
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.