docs: update install
This commit is contained in:
parent
001c47724c
commit
693acf16b5
36
install.md
36
install.md
|
@ -2,7 +2,7 @@
|
||||||
title: Installation Guide
|
title: Installation Guide
|
||||||
description: A quick guide to getting started with installing and using Auxolotl.
|
description: A quick guide to getting started with installing and using Auxolotl.
|
||||||
published: false
|
published: false
|
||||||
date: 2024-05-16T21:28:42.014Z
|
date: 2024-05-16T21:37:42.122Z
|
||||||
tags: installation, tutorial
|
tags: installation, tutorial
|
||||||
editor: markdown
|
editor: markdown
|
||||||
dateCreated: 2024-05-05T15:44:03.224Z
|
dateCreated: 2024-05-05T15:44:03.224Z
|
||||||
|
@ -16,8 +16,6 @@ dateCreated: 2024-05-05T15:44:03.224Z
|
||||||
|
|
||||||
There are a few ways you can get started with Aux:
|
There are a few ways you can get started with Aux:
|
||||||
|
|
||||||
- [I want to install the full distribution.](#installing-the-aux-distribution)
|
|
||||||
- [I want to convert my existing NixOS install to Auxolotl](#converting-nixos-to-aux)
|
|
||||||
- [I just want to install the Aux package manager and command-line tool.](#installing-the-aux-command-line-tool)
|
- [I just want to install the Aux package manager and command-line tool.](#installing-the-aux-command-line-tool)
|
||||||
|
|
||||||
Other ways to use Aux:
|
Other ways to use Aux:
|
||||||
|
@ -38,38 +36,6 @@ Verify the installation by running this command:
|
||||||
$ TODO
|
$ TODO
|
||||||
```
|
```
|
||||||
|
|
||||||
## Converting NixOS to Aux
|
|
||||||
|
|
||||||
If you have an existing NixOS installation and want to convert it to use Aux, all you need to do is change your `nixpkgs` source to use the Auxolotl nixpkgs repository (substituting `<release>` with desired release - such as `unstable` or `23.11`).
|
|
||||||
|
|
||||||
### Channels
|
|
||||||
|
|
||||||
To change your `nixpkgs` channel to pull from Aux, run the following command:
|
|
||||||
|
|
||||||
```shell=
|
|
||||||
nix-channel --add https://github.com/auxolotl/nixpkgs/nixos-<release> nixpkgs
|
|
||||||
```
|
|
||||||
|
|
||||||
On your next `nix-channel --update` or `nixos-rebuild --upgrade`, Aux will get pulled.
|
|
||||||
|
|
||||||
### Flakes
|
|
||||||
|
|
||||||
Open your `flake.nix` file and change the following line:
|
|
||||||
|
|
||||||
```nix
|
|
||||||
nixpkgs.url = "github:NixOS/nixpkgs/nixos-<release>";
|
|
||||||
```
|
|
||||||
|
|
||||||
to:
|
|
||||||
|
|
||||||
```nix
|
|
||||||
nixpkgs.url = "github:auxolotl/nixpkgs/nixos-<release>";
|
|
||||||
```
|
|
||||||
|
|
||||||
## Installing the Aux distribution
|
|
||||||
|
|
||||||
==TODO==
|
|
||||||
|
|
||||||
## Other ways to use Aux
|
## Other ways to use Aux
|
||||||
|
|
||||||
### Flake templates
|
### Flake templates
|
||||||
|
|
Loading…
Reference in a new issue