From 42afdcbd8958b32ec58602a4c96e36467560bed0 Mon Sep 17 00:00:00 2001 From: Emmet Date: Sun, 11 Jun 2023 21:39:16 -0500 Subject: [PATCH] Added more documentation for important configs --- user/app/doom-emacs/README.org | 2 +- user/app/ranger/README.org | 25 +++++++++++++++++++ user/wm/xmonad/README.org | 28 ++++++++++++++++++++++ user/wm/xmonad/base-xmobarrc | 44 ---------------------------------- 4 files changed, 54 insertions(+), 45 deletions(-) create mode 100644 user/app/ranger/README.org create mode 100644 user/wm/xmonad/README.org delete mode 100644 user/wm/xmonad/base-xmobarrc diff --git a/user/app/doom-emacs/README.org b/user/app/doom-emacs/README.org index eb6e6b3..3ad9313 100644 --- a/user/app/doom-emacs/README.org +++ b/user/app/doom-emacs/README.org @@ -16,8 +16,8 @@ This directory includes my Doom Emacs configuration, which consists of: - [[./config.el][config.el]] - Main configuration - [[./init.el][init.el]] - Doom modules (easy sets of packages curated by Doom) - [[./packages.el][packages.el]] - Additional packages from Melpa (Emacs package manager). -- [[./doom.nix][doom.nix]] - Loads Nix Doom Emacs and my configuration into my flake when imported - [[./themes/doom-stylix-theme.el.mustache][doom-stylix-theme.el.mustache]] - Mustache Doom Emacs template to be used with stylix, requires my [[../../style/stylix.nix][stylix.nix module]] as well +- [[./doom.nix][doom.nix]] - Loads Nix Doom Emacs and my configuration into my flake when imported - A few other [[./scripts][random scripts]] My full config is a [[./doom.org][literate org document (doom.org)]]. diff --git a/user/app/ranger/README.org b/user/app/ranger/README.org new file mode 100644 index 0000000..08fdcfb --- /dev/null +++ b/user/app/ranger/README.org @@ -0,0 +1,25 @@ +#+title: Ranger File Manager +#+author: Emmet + +* What is Ranger? +[[https://ranger.github.io/][Ranger]] is a minimalistic TUI file manager controlled with vim keybindings (making it /extremely/ efficient). + +[[ranger.png]] + +If you've never tried a terminal file manager, I suggest you try it out. Here's a quick overview of how to work with it: +- =j= and =k= - Move up and down +- =l= - Move into a directory or open file at point +- =h= - Move up a directory +- =g g= - Move to top +- =G= - Move to bottom +- =SPC= - Mark a file +- =y y= - Copy (yank) file(s) +- =d d= - Cut file(s) +- =p p= - Paste file(s) +- =d T= - Trash file(s) +- =d D= - /Delete/ a file (no undo!) +- =!= - Run a shell command in current directory +- =@= - Run a shell command on file(s) +- =Ctrl-r= - Refresh view + +Just like in vim, commands can be given by typing a colon =:= (semicolons =;= also work in ranger!) and typing the command, i.e =:rename newfilename=. diff --git a/user/wm/xmonad/README.org b/user/wm/xmonad/README.org new file mode 100644 index 0000000..79692bb --- /dev/null +++ b/user/wm/xmonad/README.org @@ -0,0 +1,28 @@ +#+title: XMonad +#+author: Emmet + +* What is XMonad? +[[https://xmonad.org/][XMonad]] is a tiling window manager written and configured in Haskell. Since I have built up my own XMonad config over a few years, it is extremely efficient for me to operate (since it can be managed fully with the keyboard). + +[[xmonad.png]] + +With my XMonad setup, there are several auxiliary utilities required to make it a "full desktop environment." A few of these packages include: +- [[https://codeberg.org/xmobar/xmobar][xmobar]] - Status bar +- [[https://github.com/davatorium/rofi][rofi]] - App launcher +- [[https://github.com/sagb/alttab][alttab]] - Window switcher +- [[https://feh.finalrewind.org/][feh]] - Wallpaper utility +- pavucontrol and pamixer - Sound and volume control +- [[https://github.com/firecat53/networkmanager-dmenu][networkmanager_dmenu]] - Internet connection control +- brightnessctl - Screen brightness control +- [[https://www.umaxx.net/][sct]] - Adjust screen color temperature +- xkill and killall - Better than hitting Ctrl+Alt+Delete and waiting a few minutes + +* My Config +This directory includes my XMonad configuration, which consists of: +- [[./xmonad.hs][xmonad.hs]] - Main configuration +- [[./startup.sh][startup.sh]] - Startup script called by XMonad on startup +- [[./lib/Colors/Stylix.hs.mustache][lib/Colors/Stylix.hs.mustache]] - Mustache template used to generate color library to theme XMonad with Stylix +- [[./xmobarrc.mustache][xmobarrc.mustache]] - Mustache template used to generate my xmobar config themed with Stylix +- [[./xmonad.nix][xmonad.nix]] - Loads XMonad and my configuration (along with any necessary packages for my config) into my flake when imported + +My full config is a [[./xmonad.org][literate org document (xmonad.org)]]. diff --git a/user/wm/xmonad/base-xmobarrc b/user/wm/xmonad/base-xmobarrc deleted file mode 100644 index cf1d51d..0000000 --- a/user/wm/xmonad/base-xmobarrc +++ /dev/null @@ -1,44 +0,0 @@ -Config { font = "Inconsolata 18" - , additionalFonts = ["Symbols Nerd Font 14"] - , border = NoBorder - , bgColor = "colorBgNormal" - , alpha = 200 - , fgColor = "colorFgNormal" - , position = TopSize C 100 28 - , textOffset = -1 - , iconOffset = -1 - , lowerOnStart = True - , pickBroadest = False - , persistent = False - , hideOnStart = False - , iconRoot = "." - , allDesktops = True - , overrideRedirect = True - , commands = [ - Run XMonadLog - , Run Date " \xf073 %a %-m/%-d/%y %-I:%M:%S%P" "date" 10 - , Run BatteryP ["BAT0"] - ["-t", "", - "-L", "10", "-H", "80", "-p", "3", "--", - "-O","\xf313 \xf17e3% ", - "-i","\xf313 \xf17e7% ", - "-o","\xf313 \xf17e4% ", - "-L", "-15", "-H", "-5", - "-l", "color02Normal", "-m", "color05Normal", "-h", "color03Normal"] 10 - , Run Brightness - [ "-t", "\xf0eb % ", "--", - "-D", "amdgpu_bl1" - ] 2 - , Run Volume "default" "Master" - [ "-t", "", "--" - , "--on", " \xf028 % " - , "--onc", "color07Normal" - , "--off", " \xf026 Mute " - , "--offc", "color06Normal" - ] 1 - ] - , sepChar = "%" - , alignSep = "}{" - , template = " %battery% %bright%%default:Master%}%XMonadLog%{%date% " - } -}