Post-release manual updates

This commit is contained in:
Zhaofeng Li 2021-11-18 16:10:30 -08:00
parent e27cd5eed8
commit ee70b18ec6
3 changed files with 30 additions and 7 deletions

View file

@ -1,6 +1,7 @@
# Colmena
[![Manual](https://img.shields.io/badge/Manual-Unstable-informational)](https://zhaofengli.github.io/colmena/unstable)
[![Stable Manual](https://img.shields.io/badge/Manual-Stable-informational)](https://zhaofengli.github.io/colmena/stable)
[![Unstable Manual](https://img.shields.io/badge/Manual-Unstable-orange)](https://zhaofengli.github.io/colmena/unstable)
[![Build](https://github.com/zhaofengli/colmena/workflows/Build/badge.svg)](https://github.com/zhaofengli/colmena/actions/workflows/build.yml)
Colmena is a simple, stateless [NixOS](https://nixos.org) deployment tool modeled after [NixOps](https://github.com/NixOS/nixops) and [morph](https://github.com/DBCDK/morph), written in Rust.
@ -24,8 +25,15 @@ $ <b>colmena apply --on @tag-a</b>
## Installation
Colmena doesn't have a stable release yet.
To install the latest development version to the user profile, use the following command:
To install the latest stable version to the user profile, use the following command:
```bash
nix-env -if https://github.com/zhaofengli/colmena/tarball/stable
```
### Unstable Version
To install the latest development version:
```bash
nix-env -if https://github.com/zhaofengli/colmena/tarball/main
@ -37,8 +45,6 @@ Alternatively, if you have a local clone of the repo:
nix-env -if default.nix
```
### Unstable Binary Cache
A public binary cache is available at https://colmena.cachix.org, courtesy of Cachix.
This binary cache contains unstable versions of Colmena built by [GitHub Actions](https://github.com/zhaofengli/colmena/actions).

View file

@ -3,7 +3,19 @@
## Installation
<!-- STABLE_BEGIN -->
Colmena doesn't have a stable release yet.
To quickly try Colmena out, use the following command to enter an ephemeral environment with the latest stable version of `colmena`:
```bash
nix shell github:zhaofengli/colmena/stable
```
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 -->

View file

@ -3,7 +3,12 @@
## Installation
<!-- STABLE_BEGIN -->
Colmena doesn't have a stable release yet.
To install the latest stable version to the user profile, use the following command:
```bash
nix-env -if https://github.com/zhaofengli/colmena/tarball/stable
```
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 -->