Tidy README for production

- Restructure sections and add collapsible details

- Update repo tree and production note

- Mark main as production-ready in context
This commit is contained in:
2026-01-24 12:20:54 +00:00
parent cc61e6281d
commit 87c49dab23
2 changed files with 71 additions and 49 deletions

View File

@@ -3,7 +3,8 @@
"name": "Bashrc Dotfiles", "name": "Bashrc Dotfiles",
"purpose": "Global and per-user bash prompt + banner with seasonal palettes and time/season emoji accents.", "purpose": "Global and per-user bash prompt + banner with seasonal palettes and time/season emoji accents.",
"repo_root": "/home/steffen/Bashrc", "repo_root": "/home/steffen/Bashrc",
"default_branch": "main" "default_branch": "main",
"release_state": "main is production-ready"
}, },
"branches": { "branches": {
"main": { "main": {

117
README.md
View File

@@ -1,5 +1,7 @@
# Bashrc Dotfiles — Global & Portable Bash Prompt # Bashrc Dotfiles — Global & Portable Bash Prompt
Production-ready on `main`.
Elegant, portable, and easy-to-install Bash prompt with: Elegant, portable, and easy-to-install Bash prompt with:
- ✨ Two color zones - ✨ 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) ### 🐧 Linux / WSL (global, all users)
@@ -33,13 +35,6 @@ cd Bashrc
sudo bash dotfiles/install/install-linux-global.sh 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. 4) Open a new shell to see the prompt and banner.
### 🍏 macOS (per-user) ### 🍏 macOS (per-user)
@@ -82,7 +77,23 @@ After install:
--- ---
## ✅ What gets installed (PS1 + banner) <details>
<summary><strong>Installer choices</strong></summary>
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
</details>
---
<details>
<summary><strong>What gets installed</strong></summary>
### Linux / WSL ### Linux / WSL
@@ -98,20 +109,23 @@ After install:
- Copies `ps1/ps1.sh` to `~/.config/ps1/ps1.sh` - Copies `ps1/ps1.sh` to `~/.config/ps1/ps1.sh`
- Adds a source block in `~/.bashrc` and `~/.bash_profile` - Adds a source block in `~/.bashrc` and `~/.bash_profile`
</details>
--- ---
## PS1 module (when it runs) <details>
<summary><strong>PS1 module (when it runs)</strong></summary>
The prompt is loaded automatically by the installer:
- Linux/WSL: sourced from `/etc/bash.bashrc` (global) - Linux/WSL: sourced from `/etc/bash.bashrc` (global)
- macOS: sourced from `~/.bashrc` and `~/.bash_profile` (per-user) - macOS: sourced from `~/.bashrc` and `~/.bash_profile` (per-user)
You normally do not need to run `ps1.sh` manually. You normally do not need to run `ps1.sh` manually.
</details>
--- ---
## Banner (hostname + punchline + sysinfo) <details>
<summary><strong>Banner (hostname + punchline + sysinfo)</strong></summary>
On Linux/WSL, a banner is also shown on login: 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 ```bash
echo "Your punchline" | sudo tee /etc/ps1-punchline >/dev/null echo "Your punchline" | sudo tee /etc/ps1-punchline >/dev/null
``` ```
</details>
---
## 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`. 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 <details>
<summary><strong>Holidays Pack (themes)</strong></summary>
Holidays pack uses themed palettes + emojis and the contest layout order:
- Christmas, Easter, Halloween, Valentine, Thanksgiving, New Year
</details>
---
<details>
<summary><strong>Emoji palette</strong></summary>
Fixed times (all seasons): Fixed times (all seasons):
@@ -201,6 +211,7 @@ Seasonal sets (sunrise / work):
- Summer: 🌞 🏖️ 🌅 🌤 / 🏄 🏖️ 🚤 🌴 - Summer: 🌞 🏖️ 🌅 🌤 / 🏄 🏖️ 🚤 🌴
- Autumn: 🍁 🍂 🌫️ 🌦️ / 🍂 🍄 🎃 🪵 - Autumn: 🍁 🍂 🌫️ 🌦️ / 🍂 🍄 🎃 🪵
- Winter: 🏔️ 🌨️ ❄️ 🌌 / 🎿 ⛷️ 🏂 🧊 - Winter: 🏔️ 🌨️ ❄️ 🌌 / 🎿 ⛷️ 🏂 🧊
</details>
--- ---
@@ -209,22 +220,25 @@ Seasonal sets (sunrise / work):
```text ```text
. .
├── .context.json ├── .context.json
├── contest-styles.json
├── images/ ├── images/
── bash-pallete.png ── bash-pallete.png
dotfiles/ │ └── contest.png
├── banner/ ├── dotfiles/
── banner.sh ── banner/
├── ps1/ │ │ └── banner.sh
── ps1.sh ── ps1/
├── install/ │ │ └── ps1.sh
── install-global-ps1.sh ── install/
│ ├── install-linux-global.sh ├── install-global-ps1.sh
│ ├── install-macos-user.sh ├── install-linux-global.sh
── install-nerdfont.sh ── install-macos-user.sh
│ └── install-nerdfont.sh
└── README.md └── README.md
``` ```
## ⚙️ Overrides (Optional) <details>
<summary><strong>Overrides (Optional)</strong></summary>
Sometimes autodetection doesnt work (e.g., on macOS without fontconfig): Sometimes autodetection doesnt work (e.g., on macOS without fontconfig):
@@ -241,10 +255,12 @@ export PS1_FORCE_ASCII=1
``` ```
Add these to your `~/.bashrc` or `~/.bash_profile`. Add these to your `~/.bashrc` or `~/.bash_profile`.
</details>
--- ---
## 🙅 Disable Prompt (per user) <details>
<summary><strong>Disable prompt (per user)</strong></summary>
If you want to disable the global prompt for your account: If you want to disable the global prompt for your account:
@@ -266,10 +282,12 @@ To re-enable:
```bash ```bash
rm -f ~/.config/ps1/disable rm -f ~/.config/ps1/disable
``` ```
</details>
--- ---
## 🧪 Testing <details>
<summary><strong>Testing</strong></summary>
After install, open a new shell and run: 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. If you see a prompt with colors and emoji, things are working.
</details>
--- ---
## 💡 Usage Notes <details>
<summary><strong>Usage notes</strong></summary>
Font matters: even with Nerd Fonts installed, you must select them in your terminal settings. 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) - Windows Terminal (WSL)
If you see squares or missing glyphs, your terminal is likely using a non-Nerd font. If you see squares or missing glyphs, your terminal is likely using a non-Nerd font.
</details>
--- ---