mirror of
https://github.com/SeriousBug/dotfiles
synced 2025-12-07 05:22:34 -06:00
Add README with setup script documentation and package list
🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
parent
40b517fc58
commit
434d1f8a4b
35
README.md
Normal file
35
README.md
Normal file
|
|
@ -0,0 +1,35 @@
|
||||||
|
# Dotfiles
|
||||||
|
|
||||||
|
Personal dotfiles and configuration managed with [Dotter](https://github.com/SuperCuber/dotter). Feel free to use this as inspiration or fork it for your own setup.
|
||||||
|
|
||||||
|
## Setup
|
||||||
|
|
||||||
|
Run the setup script to install dependencies via Homebrew and deploy configurations:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
./setup.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
- `--reset` - Reset configuration and re-prompt for all variables
|
||||||
|
- `--force-deploy` - Force deployment even if files already exist
|
||||||
|
- `--skip-brew` - Skip Homebrew package installation
|
||||||
|
|
||||||
|
### Installed Packages
|
||||||
|
|
||||||
|
The setup script installs the following packages via Homebrew:
|
||||||
|
|
||||||
|
- dotter, fish, dust, eza, gh, htop, go, jq, lazygit, neovim, asdf, bat, pandoc, ripgrep, zoxide, zellij, p7zip
|
||||||
|
|
||||||
|
**macOS only:**
|
||||||
|
- font-fira-code-nerd-font, orbstack
|
||||||
|
|
||||||
|
## Included Configurations
|
||||||
|
|
||||||
|
- Git
|
||||||
|
- Neovim
|
||||||
|
- Fish shell
|
||||||
|
- Zellij
|
||||||
|
- Htop
|
||||||
|
- ASDF
|
||||||
Loading…
Reference in a new issue