diff --git a/README.md b/README.md index c27d780..4514ed9 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,30 @@ # tritonshell -### a nix devshell for triton +### a nix dev & ops shell for [triton](https://www.joyent.com/triton/compute) and [manta](https://www.joyent.com/triton/object-storage) -0. If you're already on NixOS jump to 2. -1. [Install nix](https://nixos.org/download.html) - 1. Now, make sure you're ready to nix with flakes, this should give you some output: +0. If you're already on NixOS and have worked with `flakes` before, jump to 2. +1. [Install nix, the package manager](https://nixos.org/download.html) + + 1. Now, make sure you're ready to `nix` with flakes, this should give you some output: ``` nix flake --help ``` 2. Otherwise, proceed to enable flakes (still an experimental feature in `nix`): https://nixos.wiki/wiki/Flakes#Installing_flakes + 2. Get this nix flake template, it will be setup in a new directory `./tritonshell` (feel free to adjust this): ``` nix flake new --template "git+https://git.greenbaum.cloud/greenbaum.cloud/tritonshell?ref=main" ./tritonshell +cd tritonshell ``` + 3. Ready to go: ``` nix develop ``` + + +**Optional**: +TODO: add `nix-direnv`