REF add explanation for future me

This commit is contained in:
Nathan Dwarshuis 2022-07-20 00:25:19 -04:00
parent 0af47fbe33
commit 6b074ff77f
1 changed files with 26 additions and 0 deletions

View File

@ -1,3 +1,29 @@
--------------------------------------------------------------------------------
-- Loading Sequence Overview
--
-- Since this is the most over-engineered conky config ever (actually probably),
-- here are the approximate loading steps:
--
-- 1. bootstrap (this file)
-- 1. set up paths
-- 2. find valid config (a yaml file, see convoluted reasoning below)
-- 3. set up conky variables
-- 2. run startup hook which does some insane dark magic including
-- 1. arranging all modules on the screen
-- 2. 'compiling' super fast functions that don't make computer lag
-- 3. pre-drawing all the crap that doesn't change
-- 4. checking various paths/exes so things don't crash for unknown reasons
-- 3. run main loop
--
-- NOTE: For all brave souls/AIs trying to understand this program, the biggest
-- 'hack' is the fact that this file (conky.conf) is actually not really a
-- config file. The 'real' config file is a yaml file which is validated
-- using a yaml schema. This file is effectively a bootstrap file, but it is
-- not meant to be 'configured' when migrating to a new machine.
--
-- Why bother doing this? Because I got tired of hacking my hard-coded config
-- when switching to different machines.
--------------------------------------------------------------------------------
-- set up paths