From 4368dd0f4fd5cb37db6f6e0d2b19d6d847917e2c Mon Sep 17 00:00:00 2001 From: pvincent Date: Tue, 18 Aug 2026 21:48:03 +0400 Subject: [PATCH] better readme --- README.md | 63 +++++++++++++++++++++++++++++-------------------------- 1 file changed, 33 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index 420f185..3c1df7b 100644 --- a/README.md +++ b/README.md @@ -1,40 +1,24 @@ # MIAOU-BASH -MIAOU-BASH is a mix of scripts and settings aiming for leveraging -your terminal experience. As the name suggests, it is based on Bash -and expect to work on most of any modern GNU/Linux. However, at -this stage, the installation process only supports 2 distribution families: +**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. -* Debian *Like* : Debian, Mint, Ubuntu, ... -* Arch *Like* : ArchLinux, Manjaro, ... +Currently, the automated installation process supports two major distribution families: +* **Debian-based:** Debian, Ubuntu, Linux Mint, etc. +* **Arch-based:** Arch Linux, Manjaro, etc. -Be aware MIAOU-BASH (uppercase) refers to the whole package itself. -Meanwhile `miaou-bash` (downcase) refers to the only one, yet useful, utility script. -To fulfill maximum expectations, we do recommend installing the *Ghostty* -terminal app. +> **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. -This is free software and licensed as: Affero GPL v3 + -Any feedback appreciated: [contact@artcode.re](mailto:contact@artcode.re) +For the absolute best experience, we highly recommend using the Ghostty terminal emulator. -## Featuring +## 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) -* [x] default settings - * [x] inputrc - * [x] bashrc - * [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 - * [ ] ... ## install @@ -59,3 +43,22 @@ Any feedback appreciated: [contact@artcode.re](mailto:contact@artcode.re) # { CTRL, ALT } + u for undo # { up, down } for history search ``` + +## Featuring +* [x] default settings + * [x] inputrc + * [x] bashrc + * [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 + * [ ] ...