Add README with installation and usage instructions

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

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
Yan Lin 2025-07-26 01:03:12 +02:00
parent 9fcb2b8dce
commit 74342069a6

39
README.md Normal file
View file

@ -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.