diff --git a/README.md b/README.md index 3d2b5ec..8eda0a3 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,53 @@ -# Fish shell configuration +# Fish shell configuration -A minimal, modular Fish configuration focused on productivity and readability. -Primarily designed for Debian servers, but easily adaptable to other systems with minimal changes. +A minimal, modular system-wide Fish shell configuration focused on productivity, consistency, and readability. + +Primarily designed for Debian servers, but easily adaptable to other OS and use cases with minimal config changes. ## Features +- Modular architecture +- System-wide installation +- Prompt themes +- Package manager profiles - Aliases - Abbreviations - Functions -- Prompt themes - Color configuration -- PATH management +- `PATH` management - `fzf` integration - Modern CLI tool defaults -## Installation +### Roadmap -Clone this repository into your Fish configuration directory: +#### Package manager backends + - [x] apt (Debian-based) + - [x] dnf (RHEL/Fedora-based) + - [x] pacman (Arch-based) + - [ ] zypper (SUSE) + - [ ] apk (Alpine) + - [ ] xbps (Void) + - [ ] pkg (FreeBSD) + - [ ] pkg (RedoxOS) + + +#### Configuration profiles + - [ ] Servers + - [ ] Proxmox host + - [ ] Generic server VM + - [ ] Desktops + - [ ] Workstation + - [ ] Personal desktop + +## Installation + +Clone this repo into the system-wide Fish config directory (run as root): + +```bash +git clone https://git.candifloss.cc/candifloss/dotfiles_fish_server.git /etc/fish +``` + +Or into your user config directory: ```bash git clone https://git.candifloss.cc/candifloss/dotfiles_fish_server.git ~/.config/fish diff --git a/config.fish b/config.fish index 7fa133c..9f9d44e 100644 --- a/config.fish +++ b/config.fish @@ -1,6 +1,14 @@ -# ~/.config/fish/config.fish -# -# Interactive shell configuration is loaded automatically from conf.d/. -# Functions are autoloaded from functions/. -# -# Keep this file minimal. \ No newline at end of file +# Put system-wide fish configuration entries here +# or in .fish files in conf.d/ +# Files in conf.d can be overridden by the user +# by files with the same name in $XDG_CONFIG_HOME/fish/conf.d + +# This file is run by all fish instances. +# To include configuration only for login shells, use +# if status is-login +# ... +# end +# To include configuration only for interactive shells, use +# if status is-interactive +# ... +# end \ No newline at end of file