diff --git a/README.md b/README.md index 85bb881..e2d479d 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,39 @@ -# Bash Git Prompt for Linux +# Bash Git Prompt on Ubuntu 24.04 Server [](#) [](#) [](#) [](./LICENSE) -A customizable Bash prompt with **five clean themes**, showing live Git repository status — branches, staged files, changes, stashes, and more. +Install Bash Git Prompt on Ubuntu 24.04 server. -Although designed for Ubuntu 24.04, it also runs smoothly on Fedora and most modern Linux distributions. +> **Note** +> Safe for production use. This tool only modifies your shell prompt and does not change system services. --- -### Features +## Why this installer exists -- Displays the current **Git branch** and live repository status -- Works across **five switchable themes** (changeable in real time) -- Shows **staged, changed, untracked, stashed, and remote** indicators -- Detects **clean vs. dirty** repository state instantly -- Compatible with Ubuntu, Fedora, and most POSIX-compatible shells -- Includes a **Nerd Font installer** for correct symbol rendering +Most Bash Git prompts out there are bloated. You have to install oh-my-zsh, oh-my-bash, or some other framework that drags in far more than you need. +This project is the opposite: a fast, lightweight Git status prompt based purely on Bash and Git’s own built-in commands. +No frameworks, no plugins, no bloat. + +--- + +## What this installer does + +✔ Shows current Git branch and live repo status +✔ Supports **five clean themes** switchable in real time +✔ Displays staged, changed, untracked, stashed, and remote state +✔ Indicates clean/dirty status immediately +✔ Lets you customise PS1 inside/outside Git repos centrally +✔ Works seamlessly over SSH +✔ Includes an **optional** Nerd Font installer --- ### Prerequisites -Requires **DejaVuSansMono Nerd Font** for proper symbol display. +Requires **DejaVuSansMono Nerd Font Mono** for proper symbol display like shown below.
@@ -62,6 +72,23 @@ cd ~/.bash-git-prompt
./install-fonts.sh
```
+---
+
+## Important note about fonts (SSH users take notice)
+
+The Git prompt uses Nerd Font symbols, but:
+
+**You only need Nerd Fonts installed on your local machine.**
+Your terminal emulator on your laptop/workstation renders the symbols — not the server.
+
+If you SSH into the server, the prompt will display correctly **as long as your local terminal already has the Nerd Font installed**.
+
+If you are installing this on a remote server, you can safely skip the font installer.
+
+---
+
+## Make it happen
+
Add the following to your .bashrc file:
```