From 9db392e8ae84a6fb3a0aa472346b3cde7f49a938 Mon Sep 17 00:00:00 2001 From: Phluxjr23 Date: Sun, 9 Nov 2025 18:35:00 -0600 Subject: [PATCH] readme readme is now readable --- README.md | 64 ++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 63 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3293206..daa404a 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,64 @@ # confy -A config manager for linux/unix based systems including MacOS (Unix). + +a config manager for linux/unix based systems including macos (unix). + +simple tui for keeping track of all your config files in one place. no more hunting through ~/.config. + +image + + +## features + +- track config files from anywhere +- open in $EDITOR with one keypress +- remembers last edited file +- vim-style keybinds +- lightweight and fast +- works on linux, macos, bsd, whatever + +## installation + +```bash +git clone https://github.com/Phluxjr23/confy.git +cd confy +chmod +x main.py +sudo mv main.py /usr/local/bin/confy +``` + +## dependencies + +- python3 +- ranger (for file picker) +- curses (usually included with python) + +## usage + +just run `confy` in your terminal + +### keybinds + +- `j/k` or `arrow keys` - navigate +- `enter` - open selected file in $EDITOR +- `:` - enter command mode +- `q` - quit + +### commands + +- `:ac` - add config (opens ranger file picker) +- `:rm` - remove selected file +- `:l` - open last edited file +- `:q` - quit + +## why confy? + +tired of doing `cd ~/.config/whatever` a million times a day? same. confy keeps all your important configs in one list so you can jump to them instantly. + +simple, fast, does one thing well. + +## license + +mit + +## btw + +i use arch btw