Added more documentation for important configs

This commit is contained in:
Emmet 2023-06-11 21:39:16 -05:00
parent 2615d4d255
commit 42afdcbd89
4 changed files with 54 additions and 45 deletions

View file

@ -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)]].

View file

@ -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=.

28
user/wm/xmonad/README.org Normal file
View file

@ -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)]].

View file

@ -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 "<fc=color06Normal> <fn=1>\xf073</fn> %a %-m/%-d/%y %-I:%M:%S%P</fc>" "date" 10
, Run BatteryP ["BAT0"]
["-t", "<acstatus>",
"-L", "10", "-H", "80", "-p", "3", "--",
"-O","<fc=colorFgNormal><fn=1>\xf313</fn></fc> <fc=color03Normal> <fn=1>\xf17e3</fn><left>% </fc>",
"-i","<fc=colorFgNormal><fn=1>\xf313</fn></fc> <fc=color03Normal> <fn=1>\xf17e7</fn><left>% </fc>",
"-o","<fc=colorFgNormal><fn=1>\xf313</fn></fc> <fc=color02Normal> <fn=1>\xf17e4</fn><left>% </fc>",
"-L", "-15", "-H", "-5",
"-l", "color02Normal", "-m", "color05Normal", "-h", "color03Normal"] 10
, Run Brightness
[ "-t", "<fc=color04Normal><fn=1>\xf0eb</fn> <percent>% </fc>", "--",
"-D", "amdgpu_bl1"
] 2
, Run Volume "default" "Master"
[ "-t", "<status>", "--"
, "--on", "<fc=color07Normal> <fn=1>\xf028</fn> <volume>% </fc>"
, "--onc", "color07Normal"
, "--off", "<fc=color06Normal> <fn=1>\xf026</fn> Mute </fc>"
, "--offc", "color06Normal"
] 1
]
, sepChar = "%"
, alignSep = "}{"
, template = " %battery% %bright%<action=`xdotool key Super_L+y`>%default:Master%</action>}<box color=colorBgBright width=0>%XMonadLog%</box>{<action=`xdotool key Super_L+c`>%date%</action> "
}
}