From e4dd6cddd0d57b6ed719e36736b315f1bc9dc0c8 Mon Sep 17 00:00:00 2001
From: Aly Raffauf <achacega@gmail.com>
Date: Mon, 4 Mar 2024 23:13:18 -0500
Subject: [PATCH] Create README.md

---
 README.md | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 00000000..cd2dd9b3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+# nixcfg
+
+## Deploying to NixOS
+> :red_circle: **READ**: **Do not deploy this flake directly to your machine. It won't work.**
+> This is my own NixOS and home-manager flake for my personal devices.
+> This includes laptops running nixos-unstable and a home lab/gaming desktop running [Slateblue](https://github.com/alyraffauf/slateblue),
+> a customized [Fedora Silverblue](https://fedoraproject.org/atomic-desktops/silverblue/) image made with [BlueBuild](https://github.com/blue-build/template).
+> Each hardware-configuration is host-specific. If you fork this repository, replace them with the hardware-configuration.nix that NixOS generates for you.
+
+### Enabling Flakes
+Add the following lines to your `configuration.nix` and rebuild.
+```nix
+nix.settings.experimental-features = [ "nix-command" "flakes" ];
+```
+### Building Flake
+Run the following command.
+```bash
+sudo nixos-rebuild boot --flake github:alyraffauf/nixcfg
+```
+Reboot and the flake's configuration will be applied.