From 74342069a6b867699efe735105a69d61025899e5 Mon Sep 17 00:00:00 2001
From: Yan Lin <lyan@cs.aau.dk>
Date: Sat, 26 Jul 2025 01:03:12 +0200
Subject: [PATCH] Add README with installation and usage instructions
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
---
 README.md | 39 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..49cb2b9
--- /dev/null
+++ b/README.md
@@ -0,0 +1,39 @@
+# Personal Nix Configuration
+
+A simple Nix configuration for macOS using nix-darwin and home-manager. Largely generated by Claude Code.
+
+## Quick Install
+
+Install directly from GitHub without cloning:
+
+```bash
+# Darwin system configuration
+sudo darwin-rebuild switch --flake github:Logan-Lin/nix-config
+
+# Home Manager configuration  
+home-manager switch --flake github:Logan-Lin/nix-config#yanlin
+```
+
+## What's Included
+
+- **nix-darwin**: System-level macOS configuration
+- **home-manager**: User environment and dotfiles
+- **Neovim**: Configured with treesitter, file explorer, and gruvbox theme
+- **Tmux**: Vim-like keybindings with gruvbox colors
+- **Packages**: LaTeX, Python, btop, fonts, and development tools
+
+## Usage
+
+```bash
+# Update and switch configuration
+nix flake update
+sudo darwin-rebuild switch --flake .
+home-manager switch --flake .#yanlin
+```
+
+## Machines
+
+- `iMac` - iMac configuration
+- `mba` - MacBook Air configuration
+
+For now, both machines use the same base configuration with potential for machine-specific customizations.