Skip to content

Commit

Permalink
docs: revamp getting started
Browse files Browse the repository at this point in the history
  • Loading branch information
domenkozar committed Jul 15, 2023
1 parent b3e36aa commit ebf4a08
Showing 1 changed file with 6 additions and 7 deletions.
13 changes: 6 additions & 7 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
Here are the minimum steps to get started.

## Installation


a) Install [Nix](https://nixos.org)
### 1. Install [Nix](https://nixos.org)

=== "Linux"

Expand All @@ -28,7 +27,9 @@ a) Install [Nix](https://nixos.org)
docker run -it nixos/nix
```

b) Install [Cachix](https://cachix.org) (recommended, speeds up the installation by providing binaries)
### 2. Install [Cachix](https://cachix.org)

Recommended, speeds up the installation by providing binaries.

=== "Newcomers"

Expand All @@ -44,14 +45,12 @@ b) Install [Cachix](https://cachix.org) (recommended, speeds up the installation
cachix use devenv
```

c) Install ``devenv``
### 3. Install [devenv](https://github.com/cachix/devenv)


!!! note

To update `devenv`, rerun the installation commands below.

If you get errors that `devenv` already exists, run `nix profile list` and `nix profile remove <number>` beforehand.
To update `devenv` follow the installation commands below.

=== "Newcomers"

Expand Down

0 comments on commit ebf4a08

Please sign in to comment.