set up basic structure for help, also made minor tweaks to install.sh and layouts.

2026-05-21 16:44:11 +02:00
parent eb845cb8e1
commit bd1d2f3522
27 changed files with 147 additions and 6 deletions
@@ -0,0 +1,77 @@
+> Included Utility scripts
+
+SDG-OS has a couple of utility scripts, all of which can be found under ~/.config/sdgos
+
+#help/cmd-help.sh#
+this script presents a searchable list of commands with their TLDR explainers on the right to the user. 
+the list of commands can be found in cmds.list. 
+when the user selects a command, it'll open the man page for that command.
+
+this is bound to the bind *super+H* and the terminal alias `tldrtui`
+
+#help/help.sh#
+shows this menu! it effectively just shows you all the files in the topics folder with their contents. 
+
+this is bound to the bind *super+shift+H* and the terminal alias `tldrtui`
+
+#help/references.sh#
+this script takes a list file (like references.list, mangoipc.list or DMSipc.list) and presents it using fzf. 
+this is not used directly but used through another script to present searchable reference lists.
+
+#screenshots/mode-toggle.sh#
+this script rotates between 3 save modes for screenshots. these are then used by the other scripts.
+modes are:
+save to clipboard
+save to file
+open in editor
+
+this is bound to the bind *printscreen*
+
+#screenshots/fullscreen.sh#
+takes an all-screen screenshot
+
+this is bound to the bind *super+control+printscreen*
+
+#screenshots/region.sh#
+allows you to select a region
+
+this is bound to the bind *super+printscreen*
+
+#tips/tips.list#
+this one is actually just a single line, so it doesnt have its own script, but this is the source file the tips system pulls from.
+this is the line:
+`shuf -n 1 ~/.config/sdgos/tips/tips.list`
+
+this runs automatically on opening your first terminal (not on any successive terminals)
+you can also get a tip by running `tipme` in the terminal or by pressing *super+0*
+
+#tuis/aur-install.sh#
+provides a graphical interface for browsing the AUR, including multi-select functionality and a details pane
+
+you can launch this script with the terminal alias `aurgui` or the bind *super+shift+Y*
+
+#tuis/pkg-install.sh#
+provides a graphical interface for browsing the pacman repository, including multi-select functionality and a details pane
+
+you can launch this script with the terminal alias `pacgui` or the bind *super+Y*
+
+#tuis/documentation.sh#
+provides quick access to various pieces of documentation, including various interactive reference lists. 
+
+you can launch this script with the terminal alias `documentation` or the bind *super+shift+M*
+
+#tuis/layout-switch.sh#
+allows you to switch through layouts using a selectable menu, pulls layouts from layouts.list, so new layouts can be added easily. 
+
+you can launch this script with the bind *super+W*
+
+#tuis/project-select.sh#
+shows a list of git repositories within your projects directory (default ~/projects) with their top level list of files + readme.
+when you select a git repo, it'll open this repo in code-oss (vscode). 
+
+you can launch this script with the alias `git-projects` or the bind *super+shift+tab*
+
+#mango-config.sh#
+gives you a browsable TUI for all configuration files in ~/.config/mango, with a preview, selecting an entry opens it in micro. 
+
+you can launch this script with the alias `mangoconf` or the bind *super+M*