From 216c264a7fe12de5c1fa9495d403648f3577b20d Mon Sep 17 00:00:00 2001 From: John Mertz Date: Tue, 27 Jul 2021 01:43:45 -0400 Subject: [PATCH] Add hyperlinks in README to relevant scripts --- README.md | 62 ++++++++++++++++++++++++++----------------------------- 1 file changed, 29 insertions(+), 33 deletions(-) diff --git a/README.md b/README.md index 7fd54dc..60f4ce5 100644 --- a/README.md +++ b/README.md @@ -2,15 +2,15 @@ ## Audio -**audio/mute.sh** +[**audio/mute.sh**](https://git.john.me.tz/jpm/scripts/src/branch/master/audio/mute.sh) Just a simple script to toggle Alsa mute. -**audio/noise-cancel.sh** +[**audio/noise-cancel.sh**](https://git.john.me.tz/jpm/scripts/src/branch/master/audio/noise-cancel.sh) Add a noise-cancelled version of existing interfaces to Pulseaudio. -**audio/stream-podcasts.pl** +[**audio/stream-podcasts.pl**](https://git.john.me.tz/jpm/scripts/src/branch/master/audio/stream-podcasts.pl) Commandline podcast streamer. Fetchs the feed for desired podcasts, find items published today, then plays them in order. Given arguments, it will use those @@ -21,27 +21,23 @@ as feeds, otherwise it will use the hash listed in the script. I haven't used i3 in earnest for quite some time since moving to Sway, so it is very likely that some of these scripts are broken based on other config changes. -**i3/i3move.sh** +[**i3/i3move.sh**](https://git.john.me.tz/jpm/scripts/src/branch/master/i3/i3move.sh) When any of the Xrandr scripts below is run, it will print it's name to a config file. This script will read that config file and then knows how the outputs are arranged. Once this is known, it allows hotkeys to know which output to move a workspace to. -**i3/detached.sh** +[**i3/detached.sh**](https://git.john.me.tz/jpm/scripts/src/branch/master/i3/detached.sh) Xrandr config. Just the laptop display. -**i3/detached.sh** - -Xrandr config. Just the laptop display. - -**i3/home.sh** +[**i3/home.sh**](https://git.john.me.tz/jpm/scripts/src/branch/master/i3/home.sh) Xrandr config. Not a layout I currently use. Home is now the "stacked" view from sway/displays. -**i3/work.sh** +[**i3/work.sh**](https://git.john.me.tz/jpm/scripts/src/branch/master/i3/work.sh) Xrandr config. Vertical on the left, horizontal aligned to top of the vertical, and laptop directly below that. Left-to-right order is @@ -53,28 +49,28 @@ Vertical-Horizontal-Laptop. system. I use it for a bunch of stuff to supplement i3 and Sway to fill out same desktop niceties. See configs in 'dotfiles' repository. -**rofi/drun.sh** +[**rofi/drun.sh**](https://git.john.me.tz/jpm/scripts/src/branch/master/rofi/drun.sh) Simple launcher. -**rofi/rofi-openvpn.sh** +[**rofi/rofi-openvpn.sh**](https://git.john.me.tz/jpm/scripts/src/branch/master/rofi/rofi-openvpn.sh) Quick VPN switcher. -**rofi/rofi-power-menu.sh** +[**rofi/rofi-power-menu.sh**](https://git.john.me.tz/jpm/scripts/src/branch/master/rofi/rofi-power-menu.sh) Lock, log out, restart Sway/i3, restart waybar, hibernate, reboot, shutdown. -**rofi/rofi-send-to-kodi.sh** +[**rofi/rofi-send-to-kodi.sh**](https://git.john.me.tz/jpm/scripts/src/branch/master/rofi/rofi-send-to-kodi.sh) Forward pasted link to ./send-to-kodi.sh. -**rofi/rofi-ssh-menu.sh** +[**rofi/rofi-ssh-menu.sh**](https://git.john.me.tz/jpm/scripts/src/branch/master/rofi/rofi-ssh-menu.sh) Open a terminal to any SSH shortcut machine. (TODO: Integrate with 'sshs' to get machine list from there instead of a static list). -**rofi/sway-alt-tab.sh** +[**rofi/sway-alt-tab.sh**](https://git.john.me.tz/jpm/scripts/src/branch/master/sway/sway-alt-tab.sh) Show all currently running applications in Sway to locate window. @@ -84,14 +80,14 @@ Show all currently running applications in Sway to locate window. and tiling window manager. See configs in 'dotfiles' repository. Here are some scripts exclusively for automating or enhancing Sway. -**sway/displays.pl** +[**sway/displays.pl**](https://git.john.me.tz/jpm/scripts/src/branch/master/sway/displays.pl) Script to automatically configure wayland outputs using swaymsg. Also forks waybars for each display. Allows custom configurations. No argument will run the last used configuration (~/config/last_display). '-w' will run only waybar without changing displays. -**sway/gammastep.pl** +[**sway/gammastep.pl**](https://git.john.me.tz/jpm/scripts/src/branch/master/sway/gammastep.pl) Setup Gammastep based on current location. I don't have geolocation in my laptop, so this requires a URL that returns JSON, including a "lat" and "lon". @@ -105,7 +101,7 @@ phone similar to: It forks to keep running if terminal is killed. If location fails to be fetched it will try again every 5 seconds. -**sway/popup-term.pl** +[**sway/popup-term.pl**](https://git.john.me.tz/jpm/scripts/src/branch/master/sway/popup-term.pl) A DIY version of the Tilde terminal. If terminal is not running, it opens on the current display. If it is running but not on current dislpay, it moves to @@ -135,7 +131,7 @@ it to be *hidden*. ... ``` -**sway/swayidle.sh** +[**sway/swayidle.sh**](https://git.john.me.tz/jpm/scripts/src/branch/master/sway/swayidle.sh) Work in progress. These scripts don't currently work the way I like. @@ -145,32 +141,32 @@ certain periods of inactivity as well as prior to sleep and after wake. This script is meant to unify all of the actions into one script by accepting an option. -**sway/swayidlecountdown.sh** +[**sway/swayidlecountdown.sh**](https://git.john.me.tz/jpm/scripts/src/branch/master/sway/swayidlecountdown.sh) Prior to locking a countdown should be provided. Currently testing how to manage a countdown with Dunst, which doesn't actually support dynamic notifications. ## Thinkpad -**thinkpad/blc.pl** +[**thinkpad/blc.pl**](https://git.john.me.tz/jpm/scripts/src/branch/master/thinkpad/blc.pl) Overly complicated backlight brightness control script. Provides flexible control of backlight so that changes can be easily scripted or called from keyboard shortcuts. --help provides some usage docs. -**thinkpad/kbd_backlight.pl** +[**thinkpad/kbd_backlight.pl**](https://git.john.me.tz/jpm/scripts/src/branch/master/thinkpad/kbd_backlight.pl) Simple script to cycle keyboard backlight. Gets max brightness, current brightness and then changes then increments the current brightness. Uses mod of max+1 so that it will cycle back around to 0 (disabled) if it is already at max. -**thinkpad/pow.pl** +[**thinkpad/pow.pl**](https://git.john.me.tz/jpm/scripts/src/branch/master/thinkpad/pow.pl) Overly complicated battery and power status fetcher script. Can output stats as JSON, Waybar-friendly percentage and icon, or a pretty table suitable for use with plain-text notifications via notify-send or similar. -**thinkpad/user-thinkpad-control@.service** +[**thinkpad/user-thinkpad-controls@.service**](https://git.john.me.tz/jpm/scripts/src/branch/master/thinkpad/user-thinkpad-controls@.service) SystemD unit file used to give ownership of necessary sys files to whichever user it is enabled for `systemctl enable user-thinkpad-control@jpm`. Without @@ -184,39 +180,39 @@ taskbar for Sway (and other Wlroots-based wayland compositors). Waybar applets have hover and click functionality and have several scripts related to those. See the .config repository for the actual Waybar and Sway configs. -**waybar/waybar-cpu.sh** +[**waybar/waybar-cpu.sh**](https://git.john.me.tz/jpm/scripts/src/branch/master/waybar/waybar-cpu.sh) Launch htop in floating window (bottom-right). If already running, kill it. -**waybar/waybar-disk.sh** +[**waybar/waybar-disk.sh**](https://git.john.me.tz/jpm/scripts/src/branch/master/waybar/waybar-disk.sh) Notification with disk usage summaries. Renders properly with Dunst, but not Mako. -**waybar/waybar-mem.sh** +[**waybar/waybar-mem.sh**](https://git.john.me.tz/jpm/scripts/src/branch/master/waybar/waybar-mem.sh) Notification with memory usage summaries. -**waybar/waybar-nm.sh** +[**waybar/waybar-nm.sh**](https://git.john.me.tz/jpm/scripts/src/branch/master/waybar/waybar-nm.sh) Launch nmtui in floating window (bottom-right). If already running, kill it. ## Miscellaneous -**apply-gruvbox.sh** +[**apply-gruvbox.sh**](https://git.john.me.tz/jpm/scripts/src/branch/master/apply-gruvbox.sh) A single theme version of the one provided [here](https://raw.githubusercontent.com/Mayccoll/Gogh). Applies the theme to a variety of terminals. Not really necessary after cloning the 'dotfiles' repository. -**send-to-kodi.sh** +[**send-to-kodi.sh**](https://git.john.me.tz/jpm/scripts/src/branch/master/send-to-kodi.sh) [This script](https://github.com/allejok96/send-to-kodi) sends a URL or local file to a [Kodi](https://github.com/xbmc) media player. Only modified to have my local media server IP. -**setup_wireguard.sh** +[**setup_wireguard.sh**](https://git.john.me.tz/jpm/scripts/src/branch/master/setup_wireguard.sh) Script to install WireGuard and generate a config file. Requires modification with the server public IP, server public key, and change to first 3 octets if