From 40581b944296b55435beef595fbe9c529ba72342 Mon Sep 17 00:00:00 2001 From: pvincent Date: Thu, 20 Aug 2026 22:47:44 +0400 Subject: [PATCH] better readme --- README.md | 45 +++++++++++++++++++++++++++------------------ lib/uninstall.bash | 4 ++-- 2 files changed, 29 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 3c1df7b..ebd73bd 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,31 @@ # MIAOU-BASH -**MIAOU-BASH** is a collection of scripts and configurations designed to enhance your terminal experience. As the name suggests, it is built on Bash and is designed to work on most modern GNU/Linux systems. +**MIAOU-BASH** is a collection of scripts and configurations designed to enhance + your terminal experience. As the name suggests, it is built on Bash and is +designed to work on most modern GNU/Linux systems. Currently, the automated installation process supports two major distribution families: + * **Debian-based:** Debian, Ubuntu, Linux Mint, etc. * **Arch-based:** Arch Linux, Manjaro, etc. > **A quick note on naming:** +> > * **MIAOU-BASH** (uppercase) refers to the entire project and package. -> * `miaou-bash` (lowercase) refers specifically to the core utility script included within the project. +> * `miaou-bash` (lowercase) refers specifically to the core utility script +> included within the project. -For the absolute best experience, we highly recommend using the Ghostty terminal emulator. +For the absolute best experience, we highly recommend using the [Ghostty](https://ghostty.org/) + terminal emulator. ## License & Feedback -This project is free and open-source software, licensed under the **GNU Affero General Public License v3.0 (AGPL-3.0)**. - -We would love to hear your thoughts! Any feedback, suggestions, or contributions are greatly appreciated. -[contact@artcode.re](mailto:contact@artcode.re) +This project is free and open-source software, licensed under the +**GNU Affero General Public License v3.0 (AGPL-3.0)**. +We would love to hear your thoughts! Any feedback, suggestions, or contributions +are greatly appreciated. +-- [contact@artcode.re](mailto:contact@artcode.re) ## install @@ -30,7 +37,7 @@ We would love to hear your thoughts! Any feedback, suggestions, or contributions ## uninstall -`miaou-bash --uninstall && exec bash -l` +`miaou-bash --uninstall ## Readline main bindings @@ -45,20 +52,22 @@ We would love to hear your thoughts! Any feedback, suggestions, or contributions ``` ## Featuring + * [x] default settings * [x] inputrc * [x] bashrc - * [x] some aliases (l, ll, ltr, ...) - * [x] smart prompt - * [x] git, failure aware + * [x] some aliases (l, ll, ltr, ...) + * [x] smart prompt + * [x] git, failure aware * [x] vimrc * [x] ghostty * [x] terminfo * [x] global config - * [x] miaou-bash - * [x] friendly error message - * [x] stacktrace - * [x] tools - * [x] semver-git_tag - * [x] fqdn - * [ ] ... +* [x] miaou-bash + * [x] error friendly + * [x] stacktrace + * [x] hints +* [x] tools + * [x] semver-git_tag + * [x] fqdn + * [ ] ... diff --git a/lib/uninstall.bash b/lib/uninstall.bash index c13f330..03daa29 100644 --- a/lib/uninstall.bash +++ b/lib/uninstall.bash @@ -26,9 +26,9 @@ source "$MIAOU_BASH_DIR"/lib/functions.bash assert_system_mode sudo_root if _confirm_destructive 2>/dev/null; then - cd || exit 2 # exit should not occur! uninstall - echo 'MIAOU-BASH fully uninstalled, previous settings restored from original' + echo 'MIAOU-BASH fully uninstalled, previous settings have been restored from original' + echo "to reset your shell, please run: \`exec bash -l\`" else builtin exit 1 fi