From 5411c36c88b35949d875a53f6a7c48ddbb084dea Mon Sep 17 00:00:00 2001 From: Shulhan Date: Mon, 29 Dec 2025 16:39:21 +0700 Subject: all: convert the README from asciidoc to markdow This is to make it renderable on SourceHut. While at it, group the documentation files into doc/ directory so it can be served under https://kilabit.info/project/bin.sh . --- .gitignore | 6 +++++ README | 47 ---------------------------------------- README.adoc | 1 - README.md | 71 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ doc/index.md | 1 + 5 files changed, 78 insertions(+), 48 deletions(-) create mode 100644 .gitignore delete mode 100644 README delete mode 120000 README.adoc create mode 100644 README.md create mode 120000 doc/index.md diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..1dfde35 --- /dev/null +++ b/.gitignore @@ -0,0 +1,6 @@ +# SPDX-FileCopyrightText: 2025 M. Shulhan +# +# SPDX-License-Identifier: GPL-3.0-or-later + +/doc/CHANGELOG.html +/doc/index.html diff --git a/README b/README deleted file mode 100644 index 418700f..0000000 --- a/README +++ /dev/null @@ -1,47 +0,0 @@ -= bin.sh - -A collection of shell scripts. - -== Scripts - -*chmod-x.sh*:: -Script to recursively scan directory and remove executable-bit from file that -may not an executable. - -*git-update-all.sh*:: -Script fetch the latest commits from all git repositories under a directory. - -*jwt-decode.sh*:: -Script to decode JWT with optional secret to check for signature. - -*tmux-session.sh*:: -Script to open new tmux session with start directory based on configuration in -`~/.tmux.session`. - -*wg-activate.sh*:: -Script that activate only one wireguard connection from list of -configuration in /etc/wireguard/*.conf or turning off all of them if no -parameter is given. - - -== Installation - -Clone the repository, - - $ git clone https://git.sr.ht/~shulhan/bin.sh - -Go to inside the cloned repository and run - - $ sudo make install - -To uninstall it, run - - $ sudo make uninstall - - -== Development - -https://git.sr.ht/~shulhan/bin.sh:: Link to the source code. - -// SPDX-FileCopyrightText: 2022 M. Shulhan -// SPDX-License-Identifier: GPL-3.0-or-later diff --git a/README.adoc b/README.adoc deleted file mode 120000 index 100b938..0000000 --- a/README.adoc +++ /dev/null @@ -1 +0,0 @@ -README \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..e3a12b3 --- /dev/null +++ b/README.md @@ -0,0 +1,71 @@ + + +# bin.sh + +A collection of shell scripts. + +## Scripts + +**chmod-x.sh**:: +Script to recursively scan directory and remove executable-bit from file that +may not an executable. + +**gen-password.sh**:: +Script to generate random words from Indonesian directory of hunspell. + +The hunspell-id package can be installed from AUR: +https://aur.archlinux.org/packages/hunspell-id-git . + +**git-update-all.sh**:: +Script to fetch the latest commits from all git repositories under a +directory. + +**jwt-decode.sh**:: +Script to decode JWT with optional secret to check for signature. + +**timer.sh**:: +Script to display message after X duration. + +Usage, + + $ timer.sh $TIME [$MESSAGE] + +The $TIME parameter is any format that is acceptable by sleep, for example +60, 1m, 2h. +The $MESSAGE parameter is optional. + +**tmux-session.sh**:: +Script to open new tmux session with start directory based on configuration +in `~/.tmux.session`. + +**wg-activate.sh**:: +Script that activate only one wireguard connection from list of +configuration in /etc/wireguard/\*.conf or turning off all of them if no +parameter is given. + +## Installation + +Clone the repository, + + $ git clone https://git.sr.ht/~shulhan/bin.sh + +Go to inside the cloned repository and run + + $ sudo make install + +To uninstall it, run + + $ sudo make uninstall + +## Development + +[Project page](https://kilabit.info/project/bin.sh). + +[Changelog](https://git.sr.ht/~shulhan/bin.sh/CHANGELOG.html) - Change log +for each releases. + +[Repository](https://git.sr.ht/~shulhan/bin.sh) - Link to the source code. diff --git a/doc/index.md b/doc/index.md new file mode 120000 index 0000000..32d46ee --- /dev/null +++ b/doc/index.md @@ -0,0 +1 @@ +../README.md \ No newline at end of file -- cgit v1.3