miaou/miaou-bash
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

better readme

Browse Source
This commit is contained in:
pvincent
2026-08-20 22:47:44 +04:00
parent 3bdfe54c36
commit 40581b9442
2 changed files with 29 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+27 -18
View File
@@ -1,24 +1,31 @@
# MIAOU-BASH # 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: Currently, the automated installation process supports two major distribution families:
* **Debian-based:** Debian, Ubuntu, Linux Mint, etc. * **Debian-based:** Debian, Ubuntu, Linux Mint, etc.
* **Arch-based:** Arch Linux, Manjaro, etc. * **Arch-based:** Arch Linux, Manjaro, etc.
> **A quick note on naming:** > **A quick note on naming:**
>
> * **MIAOU-BASH** (uppercase) refers to the entire project and package. > * **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 ## License & Feedback
This project is free and open-source software, licensed under the **GNU Affero General Public License v3.0 (AGPL-3.0)**. 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)
We would love to hear your thoughts! Any feedback, suggestions, or contributions
are greatly appreciated.
-- [contact@artcode.re](mailto:contact@artcode.re)
## install ## install
<!-- markdownlint-disable MD013 MD025 --> <!-- markdownlint-disable MD013 MD025 -->
@@ -30,7 +37,7 @@ We would love to hear your thoughts! Any feedback, suggestions, or contributions
## uninstall ## uninstall
`miaou-bash --uninstall && exec bash -l` `miaou-bash --uninstall
## Readline main bindings ## Readline main bindings
@@ -45,20 +52,22 @@ We would love to hear your thoughts! Any feedback, suggestions, or contributions
``` ```
## Featuring ## Featuring
* [x] default settings * [x] default settings
* [x] inputrc * [x] inputrc
* [x] bashrc * [x] bashrc
* [x] some aliases (l, ll, ltr, ...) * [x] some aliases (l, ll, ltr, ...)
* [x] smart prompt * [x] smart prompt
* [x] git, failure aware * [x] git, failure aware
* [x] vimrc * [x] vimrc
* [x] ghostty * [x] ghostty
* [x] terminfo * [x] terminfo
* [x] global config * [x] global config
* [x] miaou-bash * [x] miaou-bash
* [x] friendly error message * [x] error friendly
* [x] stacktrace * [x] stacktrace
* [x] tools * [x] hints
* [x] semver-git_tag * [x] tools
* [x] fqdn * [x] semver-git_tag
* [ ] ... * [x] fqdn
* [ ] ...
lib/uninstall.bash
+2 -2
View File
@@ -26,9 +26,9 @@ source "$MIAOU_BASH_DIR"/lib/functions.bash
assert_system_mode assert_system_mode
sudo_root sudo_root
if _confirm_destructive 2>/dev/null; then if _confirm_destructive 2>/dev/null; then
cd || exit 2 # exit should not occur!
uninstall 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 else
builtin exit 1 builtin exit 1
fi fi