diff --git a/README.md b/README.md index a34eb1a8..4a57ecfd 100644 --- a/README.md +++ b/README.md @@ -181,9 +181,20 @@ You have two different options for setting up your local workstation. pacman -S --noconfirm direnv ``` - 📍 _After `direnv` is installed be sure to **[hook it into your preferred shell](https://direnv.net/docs/hook.html)** and then run `task workstation:direnv`_ +3. [Hook `direnv` into your preferred shell](https://direnv.net/docs/hook.html), then run: -3. Install the additional **required** CLI tools + ```sh + task workstation:direnv + ``` + + 📍 _**Verify** that `direnv` is setup properly by opening a new terminal and `cd`ing into your repository. You should see something like:_ + ```sh + cd /path/to/repo + direnv: loading /path/to/repo/.envrc + direnv: export +ANSIBLE_COLLECTIONS_PATH ... +VIRTUAL_ENV ~PATH + ``` + +6. Install the additional **required** CLI tools 📍 _**Not using Homebrew or ArchLinux?** Try using the generic Linux task below, if that fails check out the [Brewfile](.taskfiles/Workstation/Brewfile)/[Archfile](.taskfiles/Workstation/Archfile) for what CLI tools needed and install them._ @@ -196,7 +207,7 @@ You have two different options for setting up your local workstation. task workstation:generic-linux ``` -4. Setup a Python virual environment by running the following task command. +7. Setup a Python virual environment by running the following task command. 📍 _This commands requires Python 3.11+ to be installed._ @@ -204,7 +215,7 @@ You have two different options for setting up your local workstation. task workstation:venv ``` -5. Continue on to 🔧 [**Stage 3**](#-stage-3-bootstrap-configuration) +8. Continue on to 🔧 [**Stage 3**](#-stage-3-bootstrap-configuration) ### 🔧 Stage 3: Bootstrap configuration @@ -295,7 +306,7 @@ You have two different options for setting up your local workstation. 2. Verify the nodes are online - 📍 _If this command **fails** you likely haven't configured `direnv` as mentioned previously in the guide._ + 📍 _If this command **fails** you likely haven't configured `direnv` as [mentioned previously](#non-devcontainer-method) in the guide._ ```sh kubectl get nodes -o wide