set up basic structure for help, also made minor tweaks to install.sh and layouts.
This commit is contained in:
+1
-1
@@ -2,7 +2,7 @@
|
||||
|
||||
echo "installing pre-requisites"
|
||||
|
||||
sudo pacman -Syu ghostty firefox dms-shell yay git nautilus brightnessctl pipewire-pulse pipewire matugen adw-gtk-theme wl-copy hyprshot grim satty stow zoxide zsh zsh-theme-powerlevel10k eza kanshi
|
||||
sudo pacman -Syu ghostty firefox dms-shell yay git nautilus brightnessctl pipewire-pulse pipewire matugen adw-gtk-theme wl-copy hyprshot grim satty code-oss zoxide zsh zsh-theme-powerlevel10k eza kanshi
|
||||
|
||||
yay -S mangowm-git dsearch-bin
|
||||
|
||||
|
||||
+1
-1
@@ -14,7 +14,7 @@ default_nmaster=1
|
||||
smartgaps=0
|
||||
|
||||
# Overview Setting
|
||||
hotarea_size=30
|
||||
hotarea_size=15
|
||||
enable_hotarea=1
|
||||
hotarea_corner=0
|
||||
ov_tab_mode=1
|
||||
|
||||
+3
-1
@@ -1,4 +1,6 @@
|
||||
#!/bin/bash
|
||||
|
||||
while $true; do
|
||||
CMD=""
|
||||
SELECTED=$(ls ~/.config/sdgos/help/topics | fzf --layout=reverse --preview-window 'right:70%:wrap' --preview="clear && bat ~/.config/sdgos/help/topics/{}")
|
||||
SELECTED=$(ls ~/.config/sdgos/help/topics | fzf --layout=reverse --preview-window 'right:70%:wrap-word' --preview="clear && bat --style=numbers -S -f -m '*:Markdown' ~/.config/sdgos/help/topics/{}")
|
||||
done
|
||||
|
||||
@@ -0,0 +1,23 @@
|
||||
> Welcome
|
||||
|
||||
Welcome to the SDG-OS Help Documentation.
|
||||
|
||||
this interface contains documentation on how to use your OS as well as the basics of customizing and configuring your OS and basic scripting and automation.
|
||||
|
||||
|
||||
#the following tools give you some quick access:
|
||||
|
||||
*super+H* or `tldrtui` in the terminal - opens a quick reference for common commands
|
||||
*super+shift+H* or `helptui` in the terminal - opens this menu
|
||||
*super+k* - shows you all the available keybinds
|
||||
*super+shift+m* or `documentation` in the terminal - opens a runner for various documentation pieces as well as quick reference lists.
|
||||
|
||||
this interface is divided into chapters (first digit), the following chapters exist:
|
||||
|
||||
- 000 - welcome and overview of SDG-OS specific functionality
|
||||
- 100 - using SDG-OS via the UI
|
||||
- 200 - terminal basics
|
||||
- 300 - customizing DMS
|
||||
- 400 - customizing Mango
|
||||
- 500 - custom scripting
|
||||
- 600 - detailed help for all of the DMS settings
|
||||
@@ -0,0 +1,41 @@
|
||||
> Included Software
|
||||
|
||||
SDG-OS comes with a small inclusion of software on top of your base install (Which can be any kind of arch-based OS)
|
||||
|
||||
#from the Arch User Repository:
|
||||
|
||||
(aur)mangowm-git - the git version of mangoWM, you *can* choose to swap this out for a pacman repository version if you wish
|
||||
(aur)dsearch-bin - indexer for file search from Dank Material shell
|
||||
|
||||
#from the pacman repositories:
|
||||
|
||||
[^apps]:
|
||||
firefox - included browser
|
||||
nautilus - included file browser
|
||||
satty - included screenshot editor
|
||||
dms-shell - included shell environment
|
||||
|
||||
[^terminal]:
|
||||
ghostty - included pre-configured terminal
|
||||
zsh - included shell
|
||||
zsh-theme-powerlevel10k - theming for zsh
|
||||
zoxide - replaces CD with a better CD that can jump, making navigation easier
|
||||
eza - replaces the ls command with a smarter ls command using coloration, icons etc.
|
||||
fzf - used for TUIs, also integrated into the terminal with `**<tab>` for fzf search for arguments
|
||||
micro - terminal text editor
|
||||
|
||||
[^utilities]:
|
||||
brightnessctl - allows screen brightness control
|
||||
pipewire-pulse - audio helper
|
||||
pipewire - display capture helper
|
||||
yay - requirement for the AUR to work
|
||||
matugen - enables auto-theming
|
||||
adw-gtk-theme - helps with auto-theming
|
||||
wl-copy - used in scripts to interact with clipboard
|
||||
hyprshot - used for screenshots
|
||||
grim - used for screenshots
|
||||
kanshi - enables better monitor configuration
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -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*
|
||||
@@ -1 +0,0 @@
|
||||
topic 1 contents
|
||||
@@ -1 +0,0 @@
|
||||
topic 2 contents
|
||||
Reference in New Issue
Block a user