diff --git a/README.md b/README.md index b3d0992..abea663 100644 --- a/README.md +++ b/README.md @@ -5,9 +5,25 @@ course subjects in college, a la CS50(x). ## Setting up -### With Nix +### With GitHub Codespaces -Make sure Nix and `direnv` are installed on your machine +If you prefer not to wrestle with setting up Nix (or installing NixOS in that matter), +you can utilize GitHub Codespaces (or another cloud dev environment service that +supports the Dev Containers configuration standard). + +[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/andreijirohdev-labs/studentops-codelab) + +### With Nix locally + +Make sure Nix and `direnv` are installed on your machine, specifically you must +have both `nix-command` and `flakes` experimental features enabled on your +`~/.config/nix/nix.conf` or `/etc/nix/nix.conf`, otherwise you need to add +`--experimental-features 'nix-command flakes` on your flags. + +Once everything is set up, allow direnv to source out the `.envrc` file at the +project root by running `direnv allow`. It will take a while to get the needed +dependencies, especially if you don't have admin permissions to add your Linux +user account as a trsuted user for the daemon (since it utilizes Cachix caches). ## Code mirrors