diff --git a/.context.json b/.context.json index d4eef7e..710924d 100644 --- a/.context.json +++ b/.context.json @@ -3,7 +3,8 @@ "name": "Bashrc Dotfiles", "purpose": "Global and per-user bash prompt + banner with seasonal palettes and time/season emoji accents.", "repo_root": "/home/steffen/Bashrc", - "default_branch": "main" + "default_branch": "main", + "release_state": "main is production-ready" }, "branches": { "main": { diff --git a/README.md b/README.md index 0cfc40a..f48bd72 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # Bashrc Dotfiles β€” Global & Portable Bash Prompt +Production-ready on `main`. + Elegant, portable, and easy-to-install Bash prompt with: - ✨ Two color zones @@ -11,7 +13,7 @@ Elegant, portable, and easy-to-install Bash prompt with: --- -## πŸš€ Install (step by step) +## πŸš€ Install ### 🐧 Linux / WSL (global, all users) @@ -33,13 +35,6 @@ cd Bashrc sudo bash dotfiles/install/install-linux-global.sh ``` -You get 3 choices in the install script: -1) PS1 only -2) Banner only -3) Both (PS1 + banner) - -To "uninstall" one part, run the script again and choose only the other. - 4) Open a new shell to see the prompt and banner. ### 🍏 macOS (per-user) @@ -82,7 +77,23 @@ After install: --- -## βœ… What gets installed (PS1 + banner) +
+Installer choices + +Linux/WSL: + +- PS1 only / Banner only / Both +- PS1 modes: Single season, Dynamic season, Contest pack, Holidays pack + +macOS: + +- PS1 modes: Single season, Dynamic season, Contest pack, Holidays pack +
+ +--- + +
+What gets installed ### Linux / WSL @@ -98,20 +109,23 @@ After install: - Copies `ps1/ps1.sh` to `~/.config/ps1/ps1.sh` - Adds a source block in `~/.bashrc` and `~/.bash_profile` +
+ --- -## PS1 module (when it runs) - -The prompt is loaded automatically by the installer: +
+PS1 module (when it runs) - Linux/WSL: sourced from `/etc/bash.bashrc` (global) - macOS: sourced from `~/.bashrc` and `~/.bash_profile` (per-user) You normally do not need to run `ps1.sh` manually. +
--- -## Banner (hostname + punchline + sysinfo) +
+Banner (hostname + punchline + sysinfo) On Linux/WSL, a banner is also shown on login: @@ -130,24 +144,7 @@ The install script prompts for a punchline and stores it in the file. You can al ```bash echo "Your punchline" | sudo tee /etc/ps1-punchline >/dev/null ``` - ---- - -## PS1 install - -Use the installer for your OS: - -### Linux / WSL (global) - -```bash -sudo bash dotfiles/install/install-linux-global.sh -``` - -### macOS (per-user) - -```bash -bash dotfiles/install/install-macos-user.sh -``` +
--- @@ -164,7 +161,9 @@ bash dotfiles/install/install-macos-user.sh --- -## 🏁 Contest Pack +## πŸŽ›οΈ Themes & Style Packs + +### 🏁 Contest Pack The contest pack is a bold, DEFCON-ready set of five styles (Aurora, Neon, Forge, Circuit, Mono) with optional layout order. It always starts on a new line and ends with `@host - /path`. @@ -188,7 +187,18 @@ It uses the same two-block layout as Aurora, but focuses on signal and minimal n --- -## πŸ˜€ Emoji palette +
+Holidays Pack (themes) + +Holidays pack uses themed palettes + emojis and the contest layout order: + +- Christmas, Easter, Halloween, Valentine, Thanksgiving, New Year +
+ +--- + +
+Emoji palette Fixed times (all seasons): @@ -201,6 +211,7 @@ Seasonal sets (sunrise / work): - Summer: 🌞 πŸ–οΈ πŸŒ… 🌀 / πŸ„ πŸ–οΈ 🚀 🌴 - Autumn: 🍁 πŸ‚ 🌫️ 🌦️ / πŸ‚ πŸ„ πŸŽƒ πŸͺ΅ - Winter: πŸ”οΈ 🌨️ ❄️ 🌌 / 🎿 ⛷️ πŸ‚ 🧊 +
--- @@ -209,22 +220,25 @@ Seasonal sets (sunrise / work): ```text . β”œβ”€β”€ .context.json +β”œβ”€β”€ contest-styles.json β”œβ”€β”€ images/ -β”‚ └── bash-pallete.png -dotfiles/ -β”œβ”€β”€ banner/ -β”‚ └── banner.sh -β”œβ”€β”€ ps1/ -β”‚ └── ps1.sh -β”œβ”€β”€ install/ -β”‚ β”œβ”€β”€ install-global-ps1.sh -β”‚ β”œβ”€β”€ install-linux-global.sh -β”‚ β”œβ”€β”€ install-macos-user.sh -β”‚ └── install-nerdfont.sh +β”‚ β”œβ”€β”€ bash-pallete.png +β”‚ └── contest.png +β”œβ”€β”€ dotfiles/ +β”‚ β”œβ”€β”€ banner/ +β”‚ β”‚ └── banner.sh +β”‚ β”œβ”€β”€ ps1/ +β”‚ β”‚ └── ps1.sh +β”‚ └── install/ +β”‚ β”œβ”€β”€ install-global-ps1.sh +β”‚ β”œβ”€β”€ install-linux-global.sh +β”‚ β”œβ”€β”€ install-macos-user.sh +β”‚ └── install-nerdfont.sh └── README.md ``` -## βš™οΈ Overrides (Optional) +
+Overrides (Optional) Sometimes autodetection doesn’t work (e.g., on macOS without fontconfig): @@ -241,10 +255,12 @@ export PS1_FORCE_ASCII=1 ``` Add these to your `~/.bashrc` or `~/.bash_profile`. +
--- -## πŸ™… Disable Prompt (per user) +
+Disable prompt (per user) If you want to disable the global prompt for your account: @@ -266,10 +282,12 @@ To re-enable: ```bash rm -f ~/.config/ps1/disable ``` +
--- -## πŸ§ͺ Testing +
+Testing After install, open a new shell and run: @@ -278,10 +296,12 @@ bash -i -c 'echo OK' ``` If you see a prompt with colors and emoji, things are working. +
--- -## πŸ’‘ Usage Notes +
+Usage notes Font matters: even with Nerd Fonts installed, you must select them in your terminal settings. @@ -294,6 +314,7 @@ Works on terminals like: - Windows Terminal (WSL) If you see squares or missing glyphs, your terminal is likely using a non-Nerd font. +
---