commit c3ee62791c04cc75cd9986e6823ab8d1dd5d3a1f
parent 67c170932f1674de5d81d2e67e77f99291eaad78
Author: Wim Dupont <wim@wimdupont.com>
Date: Sat, 9 Apr 2022 11:39:29 +0200
changed readme to adoc
Diffstat:
| A | README.adoc | | | 78 | ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
| D | README.md | | | 72 | ------------------------------------------------------------------------ |
2 files changed, 78 insertions(+), 72 deletions(-)
diff --git a/README.adoc b/README.adoc
@@ -0,0 +1,78 @@
+= Scripts
+
+For certain scripts I've added a _"requires"_ section to specify software which is less likely to be installed by default that the script uses.
+Most of these can be changed with alternatives by choice if willing to edit the script.
+
+== ./bin/coin
+
+Used to grab cryptocurrency data, including market price. The data itself is powered by CoinGecko API.
+This script could easily be chained with dunst (https://github.com/dunst-project/dunst) to have the output as notification.
+
+.Requires:
+
+* jq (https://github.com/stedolan/jq)
+
+image::docs/coin-in-dunst.png[coin-in-dunst.png]
+
+== ./bin/decr
+
+Decrypts a GPG encrypted TAR file.
+
+== ./bin/encr
+
+Archives a given file or directory as a TAR file and encrypts it with GPG using symmetric encryption.
+
+== ./bin/mpvd
+
+Uses dmenu to browse through music directory, including option to shuffle when choosing to play a directory.
+
+.Requires:
+
+* dmenu (https://git.suckless.org/dmenu/)
+* urxvt (https://github.com/bookercodes/awesome-urxvt)
+* mpv (https://github.com/mpv-player/mpv)
+
+== ./bin/otp
+
+Lists files safed under the "~/.password-store/totp/" directory in dmenu and generates TOTP codes based on chosen file.
+
+.Requires:
+
+* pass (https://git.zx2c4.com/password-store/)
+* pass-otp (https://github.com/tadfisher/pass-otp)
+* dmenu (https://git.suckless.org/dmenu/)
+
+== ./bin/pwu
+
+Lists files safed under the "~/.password-store/" directory in dmenu. The chosen file gets opened using pass followed by:
+* password (first line) get saved in clipboard
+* username (second line) gets saved in primary using xclip
+* URL (third line) gets opened in default browser using xdg-open
+
+Only first line is mandatory for this script to be useful, usernames en URL's can be added to files where and when preferred.
+
+.Requires:
+
+* pass (https://git.zx2c4.com/password-store/)
+* dmenu (https://git.suckless.org/dmenu/)
+* xclip (https://github.com/astrand/xclip)
+
+== ./bin/yt
+
+Uses mpv and youtube-dl to easily look up videos from command-line with an audio-only option and an option to specify the amount of results.
+
+.Requires:
+
+* mpv (https://github.com/mpv-player/mpv)
+* youtube-dl (https://github.com/ytdl-org/youtube-dl)
+
+== ./yt-dl-album.sh
+
+Used to download full albums by playlist. The script creates a directory with the bandname followed by a directory with albumname in which the playlist is saved as mp3 files.
+The downloaded audio files also get tagged by id3 to make them easy to sort by on devices such as mp3-players.
+
+.Requires:
+
+* youtube-dl (https://github.com/ytdl-org/youtube-dl)
+* ffmpeg (https://git.ffmpeg.org/ffmpeg.git)
+* id3 (https://github.com/squell/id3)
diff --git a/README.md b/README.md
@@ -1,72 +0,0 @@
-# Scripts
-
-For certain scripts I've added a "requires" section to specify software which is less likely to be installed by default that the script uses.
-Most of these can be changed with alternatives by choice if willing to edit the script.
-
-## ./bin/coin
-
-Used to grab cryptocurrency data, including market price. The data itself is powered by CoinGecko API.
-This script could easily be chained with dunst (https://github.com/dunst-project/dunst) to have the output as notification.
-
-**Requires:**
-* jq (https://github.com/stedolan/jq)
-
-
-
-## ./bin/decr
-
-Decrypts a GPG encrypted TAR file.
-
-## ./bin/encr
-
-Archives a given file or directory as a TAR file and encrypts it with GPG using symmetric encryption.
-
-## ./bin/mpvd
-
-Uses dmenu to browse through music directory, including option to shuffle when choosing to play a directory.
-
-**Requires:**
-* dmenu (https://git.suckless.org/dmenu/)
-* urxvt (https://github.com/bookercodes/awesome-urxvt)
-* mpv (https://github.com/mpv-player/mpv)
-
-## ./bin/otp
-
-Lists files safed under the "~/.password-store/totp/" directory in dmenu and generates TOTP codes based on chosen file.
-
-**Requires:**
-* pass (https://git.zx2c4.com/password-store/)
-* pass-otp (https://github.com/tadfisher/pass-otp)
-* dmenu (https://git.suckless.org/dmenu/)
-
-## ./bin/pwu
-
-Lists files safed under the "~/.password-store/" directory in dmenu. The chosen file gets opened using pass followed by:
-* password (first line) get saved in clipboard
-* username (second line) gets saved in primary using xclip
-* URL (third line) gets opened in default browser using xdg-open
-
-Only first line is mandatory for this script to be useful, usernames en URL's can be added to files where and when preferred.
-
-**Requires:**
-* pass (https://git.zx2c4.com/password-store/)
-* dmenu (https://git.suckless.org/dmenu/)
-* xclip (https://github.com/astrand/xclip)
-
-## ./bin/yt
-
-Uses mpv and youtube-dl to easily look up videos from command-line with an audio-only option and an option to specify the amount of results.
-
-**Requires:**
-* mpv (https://github.com/mpv-player/mpv)
-* youtube-dl (https://github.com/ytdl-org/youtube-dl)
-
-## ./yt-dl-album.sh
-
-Used to download full albums by playlist. The script creates a directory with the bandname followed by a directory with albumname in which the playlist is saved as mp3 files.
-The downloaded audio files also get tagged by id3 to make them easy to sort by on devices such as mp3-players.
-
-**Requires:**
-* youtube-dl (https://github.com/ytdl-org/youtube-dl)
-* ffmpeg (https://git.ffmpeg.org/ffmpeg.git)
-* id3 (https://github.com/squell/id3)
