diff --git a/install.sh b/install.sh index b950f42..dd6b435 100644 --- a/install.sh +++ b/install.sh @@ -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 diff --git a/mango/layouts.conf b/mango/layouts.conf index 55161a2..f8753ce 100644 --- a/mango/layouts.conf +++ b/mango/layouts.conf @@ -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 diff --git a/sdgos/help/help.sh b/sdgos/help/help.sh index 42548ac..d7e9e13 100755 --- a/sdgos/help/help.sh +++ b/sdgos/help/help.sh @@ -1,4 +1,6 @@ #!/bin/bash -CMD="" -SELECTED=$(ls ~/.config/sdgos/help/topics | fzf --layout=reverse --preview-window 'right:70%:wrap' --preview="clear && bat ~/.config/sdgos/help/topics/{}") \ No newline at end of file +while $true; do + CMD="" + 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 diff --git a/sdgos/help/topics/000 welcome b/sdgos/help/topics/000 welcome new file mode 100644 index 0000000..53764f7 --- /dev/null +++ b/sdgos/help/topics/000 welcome @@ -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 diff --git a/sdgos/help/topics/001 SDG-OS included software b/sdgos/help/topics/001 SDG-OS included software new file mode 100644 index 0000000..ace4b12 --- /dev/null +++ b/sdgos/help/topics/001 SDG-OS included software @@ -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 `**` 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 + + + + diff --git a/sdgos/help/topics/002 SDG-OS Included utility scripts b/sdgos/help/topics/002 SDG-OS Included utility scripts new file mode 100644 index 0000000..362a0cd --- /dev/null +++ b/sdgos/help/topics/002 SDG-OS Included utility scripts @@ -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* \ No newline at end of file diff --git a/sdgos/help/topics/003 SDG-OS important keybinds b/sdgos/help/topics/003 SDG-OS important keybinds new file mode 100644 index 0000000..e69de29 diff --git a/sdgos/help/topics/004 using SDG-OS functions b/sdgos/help/topics/004 using SDG-OS functions new file mode 100644 index 0000000..e69de29 diff --git a/sdgos/help/topics/101 accessing the settings menu b/sdgos/help/topics/101 accessing the settings menu new file mode 100644 index 0000000..e69de29 diff --git a/sdgos/help/topics/102 overview of other menus b/sdgos/help/topics/102 overview of other menus new file mode 100644 index 0000000..e69de29 diff --git a/sdgos/help/topics/103 window management b/sdgos/help/topics/103 window management new file mode 100644 index 0000000..e69de29 diff --git a/sdgos/help/topics/104 installing applications b/sdgos/help/topics/104 installing applications new file mode 100644 index 0000000..e69de29 diff --git a/sdgos/help/topics/105 layouts b/sdgos/help/topics/105 layouts new file mode 100644 index 0000000..e69de29 diff --git a/sdgos/help/topics/201 basic navigation in the terminal b/sdgos/help/topics/201 basic navigation in the terminal new file mode 100644 index 0000000..e69de29 diff --git a/sdgos/help/topics/202 basic file modification in the terminal b/sdgos/help/topics/202 basic file modification in the terminal new file mode 100644 index 0000000..e69de29 diff --git a/sdgos/help/topics/203 basic terminal utilities b/sdgos/help/topics/203 basic terminal utilities new file mode 100644 index 0000000..e69de29 diff --git a/sdgos/help/topics/204 terminal piping b/sdgos/help/topics/204 terminal piping new file mode 100644 index 0000000..e69de29 diff --git a/sdgos/help/topics/301 customizing DMS b/sdgos/help/topics/301 customizing DMS new file mode 100644 index 0000000..e69de29 diff --git a/sdgos/help/topics/401 customizing mango - layouts b/sdgos/help/topics/401 customizing mango - layouts new file mode 100644 index 0000000..e69de29 diff --git a/sdgos/help/topics/402 customizing mango - binds b/sdgos/help/topics/402 customizing mango - binds new file mode 100644 index 0000000..e69de29 diff --git a/sdgos/help/topics/403 customizing mango - decoration b/sdgos/help/topics/403 customizing mango - decoration new file mode 100644 index 0000000..e69de29 diff --git a/sdgos/help/topics/404 customizing mango - autostart b/sdgos/help/topics/404 customizing mango - autostart new file mode 100644 index 0000000..e69de29 diff --git a/sdgos/help/topics/405 customizing mango - monitors b/sdgos/help/topics/405 customizing mango - monitors new file mode 100644 index 0000000..e69de29 diff --git a/sdgos/help/topics/501 scripting basics b/sdgos/help/topics/501 scripting basics new file mode 100644 index 0000000..e69de29 diff --git a/sdgos/help/topics/502 flow control b/sdgos/help/topics/502 flow control new file mode 100644 index 0000000..e69de29 diff --git a/sdgos/help/topics/topic 1 b/sdgos/help/topics/topic 1 deleted file mode 100644 index 1307bd0..0000000 --- a/sdgos/help/topics/topic 1 +++ /dev/null @@ -1 +0,0 @@ -topic 1 contents \ No newline at end of file diff --git a/sdgos/help/topics/topic 2 b/sdgos/help/topics/topic 2 deleted file mode 100644 index 670a2ec..0000000 --- a/sdgos/help/topics/topic 2 +++ /dev/null @@ -1 +0,0 @@ -topic 2 contents \ No newline at end of file