From fd175ea81f92071055558c184a85dc0a3d958d36 Mon Sep 17 00:00:00 2001 From: Nick Mello Date: Thu, 14 Aug 2025 19:26:25 -0500 Subject: [PATCH] Initial README Add README explaining the project Signed-off-by: Nicholas Mello --- README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..45797d5 --- /dev/null +++ b/README.md @@ -0,0 +1,28 @@ +# 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 ~/dotfiles +cd ~/dotfiles +./manager [tool1 tool2 ...] +```