Nick Mello
fd175ea81f
Add README explaining the project Signed-off-by: Nicholas Mello <nick@nmello.dev>
29 lines
961 B
Markdown
29 lines
961 B
Markdown
# Dotfiles Manager
|
|
|
|
A simple, reproducible, and safe dotfiles manager using Python and TOML.
|
|
Supports strict syncing, offline installs, and safe restoration of previous configurations.
|
|
|
|
---
|
|
|
|
## Features
|
|
|
|
- Manage multiple tools: Neovim, Fish, Bash, Git, Tmux, and more.
|
|
- Folder and file support: Handles both directories (`~/.config/nvim`) and individual files (`~/.gitconfig`).
|
|
- Strict sync for `store`: Ensures your Git repo always mirrors the current system configuration.
|
|
- Safe install with backups: Existing system files are moved to `.old` before installing from the repo.
|
|
- Restore: Revert to previous configurations using `.old` backups.
|
|
- Clean: Remove all `.old` backups safely.
|
|
- Flexible TOML config: Define repo paths, system paths, and file types in a structured, human-readable way.
|
|
|
|
---
|
|
|
|
## Installation
|
|
|
|
Clone this repository anywhere you like:
|
|
|
|
```bash
|
|
git clone <repo-url> ~/dotfiles
|
|
cd ~/dotfiles
|
|
./manager <action> [tool1 tool2 ...]
|
|
```
|