Readme

Author: rwblokzijl

README.md

@@ -4,68 +4,55 @@ My i3 config
 # Introduction
 
 This is my i3 configuration, it has grown in size and complexity over the years.
-
-This repo is just an occational release when i feel like it. The original is
+This repo is just an occasional release when i feel like it. The original is
 managed in a private repo.
 
-This repo consists of a number of scripts that eventually generate configs for
-the following programs:
- - i3 (example in config_generated_example)
- - rofi
- - i3blocks
+The configs are generated on the fly by a few scripts you can read for yourself.
+Start at `switchconfig.sh`
 
 # Dependencies
 
-I dont really keep track of these, but the following ones at least are pretty
-important for this setup:
-
- - dmenu
- - rofi
- - i3blocks
-
-The following are also used but arent that important:
+I specified most dependencies in ./arch_reqs, but don't expect it to be
+exhaustive. The most important ones are:
 
- - Compton
- - PulseAudio
- - i3lock
- - scrot
-
-NOTE: this list is not exhaustive as there are many programs that i have
-included keybinds
+- perl
+- i3
+- rofi
+- dmenu
 
 # How to use
-1. Clone the repo into .config
-2. Copy the file in the "example" folder to .config/i3 (without .example in the
-   name)
-3. Edit them to use your desired settings
-4. run switchconfig.sh (requires "baseconfigs" to be configured)
+
+1. Clone the repo to .config/i3
+2. run ./generate.sh to generate the config with the default "profile"
+5. alternatively run switchconfig.sh to pick a profile
 
 # Things that probably wont work
 
- - Backgrounds - i store these outside the repo but set them in the config
+ - Backgrounds - i store these outside the repo but reference them in the i3 config
  - some scripts that use credentials from outside the repo
 
-# Explaination of the files and directories
+# Relevant files and directories
+
 ```
 ~/.config/i3
-├── baseconfigs - this file specifies default values for switchconfig.sh
-├── examples - examples of configs
-├── generate.sh - It generates the final config
-├── i3blocks - contains different configs for i3blocks, theses are used in profiles/style
-│   └── scripts - contains block scripts for i3blocks
-├── layouts - contains layout files used for assigning
-├── localvars - part of the current way of configuring the screensize and machine name
-├── profile - part of the current way of specifying the config files to be included, is generated by switchconfig.sh or can be hand edited
-├── profiles - contains the ingredients for the config files
-│   ├── base - contains settings for home directory and such
-│   ├── colors - contains different color schemes
-│   ├── machine - contains rig specific settings
-│   ├── keybinds - contains the keybinds that should be available everywhere
-│   ├── style - contains different style configurations
-├── rofi
-│   ├── generate.sh - generates a new rofi config based on color and style settings
-│   ├── profiles - contains the ingredients for the config files
-│   └── rofi.conf - the final generated config
-├── scripts - contains some useful and obsolete scripts
-└── switchconfig.sh - The entry point for everything, run this to pick from different preconfigurations
+├── arch_reqs
+├── i3_gen
+│   ├── generate.sh     # generates all config files into their proper place
+│   ├── switchconfig.sh # script to pick a preset
+│   ├── bash_expand.sh  # does the actual magic of processing the configs
+│   │
+│   ├── dunst.config    # directory with config (edit here)
+│   ├── i3.config       # directory with config (edit here)
+│   ├── rofi.config     # directory with config (edit here)
+│   │
+│   ├── presets         # directory with presets
+│   └── switcher_defaults # default variables if presets doesn't specify
+├── config    # generated config file (i3)
+├── dunstrc   # generated config file (dunst)
+├── rofi.conf # generated config file (rofi)
+├── compton.conf  # regular config
+├── i3blocks.conf # regular config
+├── i3blocks
+├── layouts
+└── scripts
 ```

arch_reqs

@@ -1,15 +1,16 @@
 dmenu
 dunst
 geoip
-i3blocks
 i3-gaps
+i3blocks
 i3lock
 i3status
 networkmanager
 pavucontrol
+perl
 picom
 playerctl
 rofi
 rxvt-unicode-truecolor-wide-glyphs
-xorg-xinit
 xorg
+xorg-xinit