From e423ff9324ad0963464b3b4dd64e10b4525239b3 Mon Sep 17 00:00:00 2001 From: Andre Date: Sun, 5 May 2024 15:44:05 +0000 Subject: [PATCH] docs: create getting-started --- getting-started.md | 51 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 51 insertions(+) create mode 100644 getting-started.md diff --git a/getting-started.md b/getting-started.md new file mode 100644 index 0000000..8660085 --- /dev/null +++ b/getting-started.md @@ -0,0 +1,51 @@ +--- +title: Getting Started Guide +description: A quick guide to getting started with installing and using Auxolotl. +published: true +date: 2024-05-05T15:44:03.224Z +tags: installation, tutorial +editor: markdown +dateCreated: 2024-05-05T15:44:03.224Z +--- + +# Getting Started With Aux + +There are a few ways you can get started with Aux: + +- [I want to install the full Auxolotl distribution.](#installing-the-aux-command-line-tool) +- [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-distribution) + +## Installing the Aux command-line tool + +Open a terminal and run this command to install Aux: + +```shell= +$ TODO +``` + +Verify the installation by running this command: + +```shell= +$ 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` input to use the Auxolotl nixpkgs repository. + +Open your `flake.nix` file and change the following line: + +```nix +nixpkgs.url = "github:NixOS/nixpkgs/nixos-"; +``` + +to: + +```nix +nixpkgs.url = "github:auxolotl/nixpkgs/nixos-"; +``` + +## Installing the Aux distribution + +==TODO== \ No newline at end of file