simpler readme

This commit is contained in:
pvincent
2026-08-13 09:19:29 +04:00
parent 5ed23eb177
commit b2de3ad77a
4 changed files with 17 additions and 51 deletions
+3 -6
View File
@@ -10,6 +10,8 @@ this stage, the installation process only supports 2 distribution families:
Be aware MIAOU-BASH (uppercase) refers to the whole package itself. Be aware MIAOU-BASH (uppercase) refers to the whole package itself.
Meanwhile `miaou-bash` (downcase) refers to the only one, yet useful, utility script. 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.
This is free software and licensed as: Affero GPL v3 + This is free software and licensed as: Affero GPL v3 +
Any feedback appreciated: [contact@artcode.re](mailto:contact@artcode.re) Any feedback appreciated: [contact@artcode.re](mailto:contact@artcode.re)
@@ -32,6 +34,7 @@ Any feedback appreciated: [contact@artcode.re](mailto:contact@artcode.re)
* [x] tools * [x] tools
* [x] semver-git_tag * [x] semver-git_tag
* [x] fqdn * [x] fqdn
* [ ] ...
## install ## install
<!-- markdownlint-disable MD013 MD025 --> <!-- markdownlint-disable MD013 MD025 -->
@@ -45,12 +48,6 @@ Any feedback appreciated: [contact@artcode.re](mailto:contact@artcode.re)
`miaou-bash --uninstall && exec bash` `miaou-bash --uninstall && exec bash`
## initiate
Rk: useful when timezone has changed or ghostty command has been installed aftwerwards
`miaou-bash --initiate`
## Readline main bindings ## Readline main bindings
```bash ```bash
+5 -36
View File
@@ -1,42 +1,11 @@
# Documentation # Documentation
* initiate
* [Bash Tips](./bash_tips.md) * [Bash Tips](./bash_tips.md)
* [Development Mode](./development.md) * [todo](./todo.md)
* [TODO](./todo.md)
## prevent last false ## initiate
function body should not end up with a ternary statement Rk: useful when timezone has changed or ghostty command has been installed aftwerwards
### wrong last `miaou-bash --initiate`
Compound of 2 'false' statement returns false.
```bash
[[ : ]] && [[ : ]]
```
### right last
```bash
[[ : ]] && [[ : ]] || true
```
## arithmetic issue
last (++) statement does not complete successfully!
### wrong ++
```bash
count=0
(( ++count )) # ok
(( ++count )) # last statement in function returns false
```
### right ++
```bash
count=0
count=$((count+1))
```
+5 -5
View File
@@ -58,11 +58,11 @@ function link_etc {
function arch_vimrc { function arch_vimrc {
mkdir -p /etc/vim mkdir -p /etc/vim
if ! grep -q '/etc/vim/vimrc.local' /etc/vimrc; then if ! grep -q '/etc/vim/vimrc.local' /etc/vimrc; then
cat >>/etc/vimrc <<-EOF cat >>/etc/vimrc <<EOF
" Source a global configuration file if available " Source a global configuration file if available
if filereadable("/etc/vim/vimrc.local") if filereadable("/etc/vim/vimrc.local")
source /etc/vim/vimrc.local source /etc/vim/vimrc.local
endif endif
EOF EOF
echo "vimrc source /etc/vim/vimrc.local if any" echo "vimrc source /etc/vim/vimrc.local if any"
fi fi
+4 -4
View File
@@ -13,10 +13,10 @@ function do_subshell_false {
} }
function do_command_error_multiline { function do_command_error_multiline {
miaou-bash <<-EOF miaou-bash <<EOF
echo ok echo ok
false false
echo SHOULD NOT APPEAR echo SHOULD NOT APPEAR
EOF EOF
} }