From c1405c5a2e89772ef6f5f4539924703c0fab6219 Mon Sep 17 00:00:00 2001
From: Bryan Ramos <bryan.ramos@concurrent-rt.com>
Date: Mon, 13 May 2024 10:20:20 -0400
Subject: [PATCH] added development environment

---
 .envrc    |  1 +
 README.md | 43 ++++++++++++++++++++++++-------------------
 flake.nix |  6 ++++++
 3 files changed, 31 insertions(+), 19 deletions(-)
 create mode 100644 .envrc

diff --git a/.envrc b/.envrc
new file mode 100644
index 0000000..3550a30
--- /dev/null
+++ b/.envrc
@@ -0,0 +1 @@
+use flake
diff --git a/README.md b/README.md
index 9fcdfbc..0ea1e96 100644
--- a/README.md
+++ b/README.md
@@ -1,27 +1,15 @@
-# My Nix Configurations ❄️‍💻
+# My Nix Configurations 💻
 
 My modular Nix configs🔥
 
-If you need a list of available packages and options:
-
-- [nixpkgs Packages](https://search.nixos.org/packages) 📦️
-- [nixpkgs Options](https://search.nixos.org/options?) 🔍️
-- [home-manager Options](https://mipmip.github.io/home-manager-option-search/) ☕️
-
-Fork this repo and create your own NixOS config✨
-
-Take inspiration💡, borrow ideas💭 and customize it to your 💖 content
-
-⚠️ Be sure to tailor any settings related to my hardware and system to your own hardware⚠️
-
 ## Requirements ⚙️
+### NixOS Configurations
+- [NixOS](https://www.nixos.org/)
+- [Nix 2.0 & Flakes enabled](https://nixos.wiki/wiki/Flakes#Enable_flakes_permanently_in_NixOS)
+### Home-Manager Configuration
+- [Nix Home-Manager](https://nix-community.github.io/home-manager/index.xhtml#sec-flakes-standalone)
 
-- [Nix package manager](https://www.nixos.org/)
-- [Nix 2.0 `flakes` enabled](https://nixos.wiki/wiki/Flakes#Enable_flakes_permanently_in_NixOS)
-- [home-manager installed](https://nix-community.github.io/home-manager/index.xhtml#sec-flakes-standalone)*optional*
-
-# End-Points Exposed ❄️🔧💻️❄️
-
+# Flake End-Points Exposed ❄️
 NixOS Configurations:
   - desktop
   - wsl
@@ -29,3 +17,20 @@ NixOS Configurations:
 
 Home-Manager Configurations:
   - workstation
+
+Fork this repo, take inspiration, borrow ideas and create your own NixOS configs & modules
+
+## Developing & Customizing 🔧
+If you need a list of available packages and options:
+- [nixpkgs Packages](https://search.nixos.org/packages) 📦️
+- [nixpkgs Options](https://search.nixos.org/options?) 🔍️
+- [Home-Manager Options](https://mipmip.github.io/home-manager-option-search/) ☕️
+
+Invoke `nix develop` to enter a development shell powered by [`just`](https://github.com/casey/just)
+Invoke `just` in order to view an available list of project scripts
+
+`user.configs.nix` is a symlink to conveniently access centrally defined common user variables from the repo root
+
+⚠️ Be sure to tailor any hardware settings to your own
+⚠️ Replace the `hardware.nix` found in the `src/system/machines/<machine>` directory
+⚠️ Run `nixos-generate-config` to generate a `hardware-configuration.nix` for your current system
diff --git a/flake.nix b/flake.nix
index 0c9d514..d1b5d57 100644
--- a/flake.nix
+++ b/flake.nix
@@ -68,5 +68,11 @@
         ./src/system/machines/workstation
       ];
     };
+
+    devShells.${system}.default = with pkgs; mkShell {
+      packages = [
+        just
+      ];
+    };
   };
 }