switch to using quicknotes directory for notes

Sanatana-Linux · Nov 12, 2023 · d279820 · d279820
1 parent 39aecf2
commit d279820
Show file tree

Hide file tree

Showing 9 changed files with 27 additions and 14 deletions.
diff --git a/.notes/index.md b/.notes/index.md
diff --git a/.notes/Additional-Resources.md → ...559cd519d7ee8c727/Additional-Resources.md b/.notes/Additional-Resources.md → ...559cd519d7ee8c727/Additional-Resources.md
diff --git a/.notes/Credit-Where-It-Is-Due.md → ...9cd519d7ee8c727/Credit-Where-It-Is-Due.md b/.notes/Credit-Where-It-Is-Due.md → ...9cd519d7ee8c727/Credit-Where-It-Is-Due.md
diff --git a/.notes/Installation.md → ...969792a2559cd519d7ee8c727/Installation.md b/.notes/Installation.md → ...969792a2559cd519d7ee8c727/Installation.md
diff --git a/.quicknote/3a52ce780950d4d969792a2559cd519d7ee8c727/Intro.md b/.quicknote/3a52ce780950d4d969792a2559cd519d7ee8c727/Intro.md
@@ -0,0 +1,12 @@
+# Introduction
+
+The documentation and working notes related to this project reside within this directory for simplicity's sake and because keeping the notes elsewhere makes loosing them only too easy as I have learned with this project in particular.
+
+> NOTE: each subdirectory of the repository should have its own `README.md` file that explains its function and lists its content.
+
+## Contents
+
+- [TODOs](./todo.md)
+- [Additional Resources](/.notes/Additional-Resources.md)
+- [Credit Where It is Due](/.notes/Credit-Where-It-Is-Due.md)
+- [Installation](/.notes/Installation.md)
diff --git a/.notes/todo.md → ...80950d4d969792a2559cd519d7ee8c727/todo.md b/.notes/todo.md → ...80950d4d969792a2559cd519d7ee8c727/todo.md
diff --git a/bin/README.md b/bin/README.md
@@ -0,0 +1,9 @@
+# bin
+
+While I have long since moved away from calling shell scripts within the configuration, preferring the use of lua to keep things consistent, this directory is still useful to store scripts that aide in the development of this configuration and testing of changes to it.
+
+## Contents
+
+| Script | Functionality                                                                                                  |
+| ------ | -------------------------------------------------------------------------------------------------------------- |
+| awmtt  | Using Xephyr, it runs a nested xserver to test any changes without breaking the current UI environment locally |
diff --git a/awmtt → bin/awmtt b/awmtt → bin/awmtt
diff --git a/rc.lua b/rc.lua
@@ -9,18 +9,18 @@
 pcall(require, "luarocks.loader")
 
 --   +---------------------------------------------------------------+
--- NOTE: See sub-directory README files for more info
--- DONE see if this works with lua 
--- now the theme files and variables bound to the beautiful. namespace
+-- NOTE: See sub-directory README files for more info on their contents
+
+-- The theme files and variables bound to the `beautiful.` namespace
 require("themes")
--- helper functions
+-- Helper functions at the `utilities.` namespace
 require("utilities")
--- locally-derived back-end functionality
+-- Locally-derived back-end functionality
 require("modules")
 -- Settings of various builtin options (and some custom layouts)
 --  with globally scoped variables
 require("configuration")
---   +---------------------------------------------------------------+
+-- Event watching functionality
 require("signal")
 -- UI elements (widgets) that the user interacts with
 require("ui")