octoleo
/
telegram-bot-bash
mirror of https://github.com/octoleo/telegram-bot-bash.git
1
1
Fork 0
Code Issues Projects Releases Wiki Activity

fix doc bash checks

This commit is contained in:
Kay Marquardt (Gnadelwartz) 2020-09-23 15:22:30 +02:00
parent 1153d654d8
commit c479c80362
4 changed files with 14 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.html
View File

@ -93,8 +93,8 @@ Written by Drew (@topkecleon) and Kay M (@gnadelwartz).
<h2>Prerequisites</h2>
<p>Uses <a href="http://github.com/dominictarr/JSON.sh">JSON.sh</a> and the magic of sed.</p>
<p>Even bashbot is written in bash, it depends on commands typically available in a Unix/Linux Environment. More concrete on the common commands provided by recent versions of <a href="https://en.wikipedia.org/wiki/List_of_GNU_Core_Utilities_commands">coreutils</a>, <a href="https://en.wikipedia.org/wiki/BusyBox#Commands">busybox</a> or <a href="https://landley.net/toybox/help.html">toybox</a>, see <a href="doc/7_develop.md#common-commands">Developer Notes</a></p>
<p><em>Note for MacOS and BSD Users:</em> As bashbot heavily uses modern bash and (gnu) grep/sed features, bashbot will not run without installing additional software, see <a href="doc/0_install.md">Install Bashbot</a></p>
<p><em>Note for emmbedded systems:</em> busybox or toybox ONLY is not sufficient, you need a to install a "real" bash, see <a href="doc/0_install.md">Install Bashbot</a></p>
<p><strong>Note for MacOS and BSD Users:</strong> As bashbot heavily uses modern bash and (gnu) grep/sed features, bashbot will not run without installing additional software, see <a href="doc/0_install.md">Install Bashbot</a></p>
<p><strong>Note for embedded systems:</strong> busybox or toybox ONLY is not sufficient, you need a to install a "real" bash, see also <a href="doc/0_install.md">Install Bashbot</a></p>
<p>Bashbot <a href="https://github.com/topkecleon/telegram-bot-bash">Documentation</a> and <a href="https://github.com/topkecleon/telegram-bot-bash/releases">Downloads</a> are available on www.github.com</p>
<h2>Documentation</h2>
<ul>
@ -272,6 +272,6 @@ It features background tasks and interactive chats, and can serve as an interfac
<p>@Gnadelwartz</p>
<h2>That's it!</h2>
<p>If you feel that there's something missing or if you found a bug, feel free to submit a pull request!</p>
<h4>$$VERSION$$ v1.0-21-g6718d24</h4>
<h4>$$VERSION$$ v1.0-22-g1153d65</h4>
</body>
</html>

6
README.md
View File

@ -16,9 +16,9 @@ Uses [JSON.sh](http://github.com/dominictarr/JSON.sh) and the magic of sed.
Even bashbot is written in bash, it depends on commands typically available in a Unix/Linux Environment.
More concrete on the common commands provided by recent versions of [coreutils](https://en.wikipedia.org/wiki/List_of_GNU_Core_Utilities_commands), [busybox](https://en.wikipedia.org/wiki/BusyBox#Commands) or [toybox](https://landley.net/toybox/help.html), see [Developer Notes](doc/7_develop.md#common-commands)
*Note for MacOS and BSD Users:* As bashbot heavily uses modern bash and (gnu) grep/sed features, bashbot will not run without installing additional software, see [Install Bashbot](doc/0_install.md)
**Note for MacOS and BSD Users:** As bashbot heavily uses modern bash and (gnu) grep/sed features, bashbot will not run without installing additional software, see [Install Bashbot](doc/0_install.md)
*Note for emmbedded systems:* busybox or toybox ONLY is not sufficient, you need a to install a "real" bash, see [Install Bashbot](doc/0_install.md)
**Note for embedded systems:** busybox or toybox ONLY is not sufficient, you need a to install a "real" bash, see also [Install Bashbot](doc/0_install.md)
Bashbot [Documentation](https://github.com/topkecleon/telegram-bot-bash) and [Downloads](https://github.com/topkecleon/telegram-bot-bash/releases) are available on www.github.com
@ -265,4 +265,4 @@ bashbotBlockRecover() {
If you feel that there's something missing or if you found a bug, feel free to submit a pull request!
#### $$VERSION$$ v1.0-21-g6718d24
#### $$VERSION$$ v1.0-22-g1153d65

8
README.txt
View File

@ -25,12 +25,12 @@ More concrete on the common commands provided by recent versions of
[toybox](https://landley.net/toybox/help.html), see [Developer
Notes](doc/7_develop.md#common-commands)
*Note for MacOS and BSD Users:* As bashbot heavily uses modern bash and (gnu)
**Note for MacOS and BSD Users:** As bashbot heavily uses modern bash and (gnu)
grep/sed features, bashbot will not run without installing additional software,
see [Install Bashbot](doc/0_install.md)
*Note for emmbedded systems:* busybox or toybox ONLY is not sufficient, you
need a to install a "real" bash, see [Install Bashbot](doc/0_install.md)
**Note for embedded systems:** busybox or toybox ONLY is not sufficient, you
need a to install a "real" bash, see also [Install Bashbot](doc/0_install.md)
Bashbot [Documentation](https://github.com/topkecleon/telegram-bot-bash) and
[Downloads](https://github.com/topkecleon/telegram-bot-bash/releases) are
@ -355,4 +355,4 @@ wait
If you feel that there's something missing or if you found a bug, feel free to
submit a pull request!
#### $$VERSION$$ v1.0-21-g6718d24
#### $$VERSION$$ v1.0-22-g1153d65

8
doc/0_install.md
View File

@ -2,7 +2,7 @@
## Check bash installation
There may be systems where bash seems to be installed but it is not, e.g. emmbedded systems, or the bash version is to old.
There may be systems where bash seems to be installed but it is not, e.g. emmbedded systems, or version is to old.
Run the following commands to see if your bash looks ok ...
```bash
@ -12,8 +12,8 @@ which bash && echo "bash seems available..."
# real bash supports ARRAY
bash -c 'eval "a=(1)" && echo "Shell supports ARRAY..."'
# check for ok version by feature
[ "$(echo "\u1111")" == "\u1111" ] && echo "Bash version may to old..."
# check for version by feature
bash -c '[ "$(echo -e "\u1111")" == "\u1111" ] || echo "Bash version seems ok ..."'
```
## Install bashbot
@ -169,5 +169,5 @@ The old format is supported for backward compatibility, but may fail for corner
#### [Next Create Bot](1_firstbot.md)
#### $$VERSION$$ v1.0-21-g6718d24
#### $$VERSION$$ v1.0-22-g1153d65