Polish README and update state JSONs

This commit is contained in:
2026-01-24 15:51:38 +00:00
parent aa862e7854
commit 77cbefe2a2
3 changed files with 38 additions and 63 deletions

View File

@@ -1,15 +1,23 @@
# Bashrc Dotfiles — Global & Portable Bash Prompt
Production-ready on `main`.
Elegant, portable, and easy-to-install Bash prompt with seasonal palettes, time-aware emoji, and clean powerline structure.
Elegant, portable, and easy-to-install Bash prompt with:
---
- ✨ Two color zones
- 🌅 Time-based emoji accents
- 🖥️ Fallback when Nerd Fonts arent available
- 📍 Shortened but informative path
- 🔘 Status-colored prompt arrow
- 🧠 Works on Linux, WSL, and macOS
## ✅ Requirements (Nerd Fonts)
This prompt relies on Nerd Font glyphs for the rounded separators.
```bash
bash dotfiles/install/install-nerdfont.sh
```
After install:
- Set your terminal font to JetBrainsMono Nerd Font (or any Nerd Font)
- Manual download: https://www.nerdfonts.com/font-downloads
If you use a nonNerd font, the prompt falls back to ASCII/Unicode.
---
@@ -63,21 +71,6 @@ bash dotfiles/install/install-macos-user.sh
source ~/.bashrc
```
### 🖼️ Nerd Fonts (optional but recommended)
```bash
bash dotfiles/install/install-nerdfont.sh
```
After install:
- Open your terminal settings
- Set font to JetBrainsMono Nerd Font (or any Nerd Font)
- Terminal must use a Nerd Font for glyphs like ``, ``, `` to render correctly
- Manual download: https://www.nerdfonts.com/font-downloads
---
<details>
<summary><strong>Installer choices</strong></summary>
@@ -95,6 +88,17 @@ macOS:
---
## ✨ Features
- Two-line, powerline-style prompt
- Seasonal palettes + time-based emoji accents
- Smart path shortening (keeps home visible)
- Status-colored prompt arrow
- Works on Linux, WSL, and macOS
- Per-user disable switch
---
<details>
<summary><strong>What gets installed</strong></summary>
@@ -151,19 +155,6 @@ echo "Your punchline" | sudo tee /etc/ps1-punchline >/dev/null
---
## 🧠 Features
- **Clean, modern powerline-style prompt**
- Zone 1: date/time/user (cool gray-blue)
- Zone 2: host/path (turquoise / cool green)
- Automatically switches emoji during the day
- Smart path shortening (keeps your home dir visible)
- Fallback to ASCII/Unicode if Nerd Fonts are not installed
- Per-user disable support
- Simple per-user or global install
---
## 🎛️ Themes & Style Packs
### 🏁 Contest Pack
@@ -223,6 +214,15 @@ Holidays pack uses themed palettes + emojis and the contest layout order:
---
## 🧭 Theme Design Notes
- **Aurora (seasonal):** calm hierarchy, subtle gradients, long-term readability
- **Contest styles:** bold contrast and distinct silhouettes for instant recognition
- **Custom pack:** experimental, high-signal variants for strong personal style
- **Holidays:** themed colors + emojis without compromising legibility
---
<details>
<summary><strong>Emoji palette</strong></summary>
@@ -373,26 +373,6 @@ Current combined palette reference:
---
## 🔥 Why this is real high-end PS1 design
- Semantic color use (identity vs location)
- Few colors, but with meaning
- Path is visible, but never dominant
- Emoji is an accent, not a gimmick
- Prompt line is calm → the command gets focus
### 🎨 Color palette (notes)
| Role | BG | Description |
| --- | --- | --- |
| Zone 1 BG | 61 | gray-blue pastel |
| Zone 1 FG | 255 | pure white |
| Zone 2 BG | 37 | turquoise / cool green |
| Path FG | 194 (FG) | light green, muted |
| Frame | 60 | darker blue |
---
## 🛠️ Contribution
Want to help improve this project?