diff --git a/.envrc b/.envrc new file mode 100644 index 0000000000..3550a30f2d --- /dev/null +++ b/.envrc @@ -0,0 +1 @@ +use flake diff --git a/.gitignore b/.gitignore index 834f104c05..c78cfaea2c 100644 --- a/.gitignore +++ b/.gitignore @@ -11,3 +11,4 @@ mesh-root.pem coordinator-root.pem justfile.env workspace +.direnv/ diff --git a/README.md b/README.md index 2d689198c9..d028ecdaa5 100644 --- a/README.md +++ b/README.md @@ -12,19 +12,27 @@ from the surrounding environment. ### Getting started 1. [Install Nix](https://zero-to-nix.com/concepts/nix-installer) -2. Enter the development environment. +2. Enter the development environment manually. ```sh nix develop .# ``` + Or use [direnv](https://direnv.net/) to automatically enter the nix shell. + On non-NixOS systems, simply install [direnv](https://direnv.net/). + When using NixOS, enabling [nix-direnv](https://github.com/nix-community/nix-direnv) results in better caching. + Additionally, you may want to add the [vscode extension](https://github.com/direnv/direnv-vscode). -3. Execute and follow instructions of + ```sh + direnv allow + ``` + +4. Execute and follow instructions of ```sh just onboard ``` -4. Provision a CoCo enables AKS cluster with +5. Provision a CoCo enables AKS cluster with ```sh just create