# 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 any modern GNU/Linux.

Actually the installation process supports only 2 distros: Debian and Arch Linux.
This package works either standalone or as a core dependency of any other
miaou-* utilities.

Be aware (uppercase) MIAOU-BASH refer to a bunch of scripts and configuration settings.
Meanwhile (downcase) `miaou-bash` refer to only one of these scripts,
maybe the most useful one!

This is free software and licensed as: Affero GPL v3 +
Any feedback would be appreciated.
[contact@artcode.re](mailto:contact@artcode.re)

## Featuring

* [x] miaou-bash
* [x] default settings
  * [x] inputrc
  * [x] vimrc
  * [x] bashrc
* [x] semver-git_tag
* [x] some aliases (l, ll, ltr, ...)
* [x] smart prompt
  * [x] git, failure aware

## install

```bash
curl -s https://git.artcode.re/miaou/miaou-bash/raw/branch/main/install.sh | \
sudo bash && source /etc/bash.bashrc
```

## upgrade

```bash
miaou-bash --self-upgrade
```

## uninstall

```bash
miaou-bash --uninstall

```

## development mode (credentials required)

* REAL_DIR=/opt/miaou-bash
* sudo mkdir -m 755 $REAL_DIR && sudo chown $(id -un) $REAL_DIR
* git clone <git@artcode.re>:miaou/miaou-bash.git $REAL_DIR
* DEV_DIR=$HOME/DEV/BASH/miaou-bash # change DEST according to your needs!
* ln -s $REAL_DIR $DEV_DIR
* cd $REAL_DIR && sudo ./install.sh

## useful library

* source /opt/miaou-bash/lib/functions.bash

## extra bindkeys

* CTRL LEFT, RIGHT => move around words, back and forward
* CTRL DELETE, BACKSPACE => delete word
* ALT DELETE, BACKSPACE => delete line from cursor
* CTRL + SHIFT + / => undo

## TODO

* [ ] prompt git shows version with `+` when there is more than one commit over current version. ie: v0.0.0 + 2 commits more should display v-1.0.0+
* [ ] semver_git_tag should append `RELEASE_NOTES.md` from this TODO markdown file, providing that NEW NOTE section below contains appropriate items to fulfill the current release note
  * [ ] git log <LATEST_TAG>..HEAD --oneline

NEW NOTE
========