From 77a7f92ed705b1c290b11258459336a354840c5a Mon Sep 17 00:00:00 2001 From: Jeremiah Ticket Date: Wed, 30 Nov 2022 10:22:46 -0700 Subject: [PATCH] Updated README --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c8e33e6..bf952ca 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,9 @@ Accessibility setup script for the i3 window manager. +## i38.sh +Released under the terms of the WTFPL License: http://www.wtfpl.net +This is a Stormux project: https://stormux.org ## Why the name? @@ -21,7 +24,15 @@ An uppercase I looks like a 1, 3 from i3, and 8 because the song [We Are 138](ht - libnotify: For sending notifications - notification-daemon: To handle notifications - pamixer: for the mute-unmute script -- jq: for getting window titles +- jq: for getting the current workspace - yad: For screen reader accessible dialogs I38 will try to detect your browser, file manager, and web browser and present you with a list of options to bind to their launch keys. It will also create bindings for pidgin and mumble if they are installed. To use the bindings, press your ratpoison mode key which is set when you run the i38.sh script. next, press the binding for the application you want, w for web browser, e for text editor, f for file manager, m for mumble, etc. To learn all the bindings, find and read the mode ratpoison section of ~/.config/i3/config. + +## Usage: + +With no arguments, create the i3 configuration. +-h: This help screen. +-u: Copy over the latest version of scripts. +-x: Generate ~/.xinitrc and ~/.xprofile. +-X: Generate ~/.xprofile only.