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-18 21:48:03 +04:00
parent 51967d7130
commit 4368dd0f4f
1 changed files with 33 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+33 -30
View File
@@ -1,40 +1,24 @@
# MIAOU-BASH # MIAOU-BASH
MIAOU-BASH is a mix of scripts and settings aiming for leveraging **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.
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:
* Debian *Like* : Debian, Mint, Ubuntu, ... Currently, the automated installation process supports two major distribution families:
* Arch *Like* : ArchLinux, Manjaro, ... * **Debian-based:** Debian, Ubuntu, Linux Mint, etc.
* **Arch-based:** Arch Linux, Manjaro, etc.
Be aware MIAOU-BASH (uppercase) refers to the whole package itself. > **A quick note on naming:**
Meanwhile `miaou-bash` (downcase) refers to the only one, yet useful, utility script. > * **MIAOU-BASH** (uppercase) refers to the entire project and package.
To fulfill maximum expectations, we do recommend installing the *Ghostty* > * `miaou-bash` (lowercase) refers specifically to the core utility script included within the project.
terminal app.
This is free software and licensed as: Affero GPL v3 + For the absolute best experience, we highly recommend using the Ghostty terminal emulator.
Any feedback appreciated: [contact@artcode.re](mailto:contact@artcode.re)
## 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 ## install
<!-- markdownlint-disable MD013 MD025 --> <!-- markdownlint-disable MD013 MD025 -->
@@ -59,3 +43,22 @@ Any feedback appreciated: [contact@artcode.re](mailto:contact@artcode.re)
# { CTRL, ALT } + u for undo # { CTRL, ALT } + u for undo
# { up, down } for history search # { 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
* [ ] ...