From bd06431dc8d878440f6eb2853543252434fad736 Mon Sep 17 00:00:00 2001
From: Brady McDonough <me@bradymcd.ca>
Date: Thu, 23 Mar 2023 18:25:14 -0600
Subject: [PATCH] Moving to be a subtree

---
 tk/Makefile => Makefile           |  0
 README.md                         | 22 +++++++++++++---------
 tk/listlogic.scm => listlogic.scm |  0
 tk/mcron.scm => mcron.scm         |  0
 tk/ports.scm => ports.scm         |  0
 tk/short.scm => short.scm         |  0
 6 files changed, 13 insertions(+), 9 deletions(-)
 rename tk/Makefile => Makefile (100%)
 rename tk/listlogic.scm => listlogic.scm (100%)
 rename tk/mcron.scm => mcron.scm (100%)
 rename tk/ports.scm => ports.scm (100%)
 rename tk/short.scm => short.scm (100%)

diff --git a/tk/Makefile b/Makefile
similarity index 100%
rename from tk/Makefile
rename to Makefile
diff --git a/README.md b/README.md
index 9968697..feb88e3 100644
--- a/README.md
+++ b/README.md
@@ -1,17 +1,21 @@
-# Guile Schemeing
-The purpose of this repository is to hold various small utilities I commonly
-use in Scheme. Running `make; sudo make install` in the tk direcory will install
-sources to the Guile `(%site-dir)` and compiled .go files to the Guile
-`(%site-ccache-dir)`. All modules are installed under the prefix `tk/`
+# tk
+tk is my Guile toolkit.     
+Each unit contains a group of tools I commonly used together or with a
+particular module.
+
+`make; sudo make install` Will install source files to `(%site-dir)` and
+compiled versions to `(%site-ccache-dir)`. All units are installed under a
+ folder named `tk/` and so are imported using `(use-modules (tk <unit>))`.
 
 ## short.scm
-Aliases to shorten common names.     
+Aliases for only the most common names. I use this literally everywhere     
 `(string->symbol)` => `(ss>)`     
 `(symbol->string)` => `(ss<)`     
 `(ssa>)` appends strings into a symbol
 
 ## listlogic.scm
-Various logical tools.
+Various logical tools. Especially useful for handling `map` and `fold` where a
+default path is required.
 
 `(display-if-not)`
 Displays a given string if the first argument is `#f`     
@@ -28,7 +32,7 @@ The common `(if var var)` pattern
 The common `(if var var default)` pattern
 
 ## mcron.scm
-Constants and functions for working with time, schedules and mcron     
+Constants and functions for working with time, schedules and mcron.
 
 `sec/min` `sec/hour` `sec/day` `sec/week`      
 Useful constants     
@@ -44,5 +48,5 @@ Converts a date string into seconds
 Returns the date as a string for logging purposes
 
 ## ports.scm
-Convenience when working with ports     
+Convenience when working with ports and parsers.     
 `(port-rewind!)`
diff --git a/tk/listlogic.scm b/listlogic.scm
similarity index 100%
rename from tk/listlogic.scm
rename to listlogic.scm
diff --git a/tk/mcron.scm b/mcron.scm
similarity index 100%
rename from tk/mcron.scm
rename to mcron.scm
diff --git a/tk/ports.scm b/ports.scm
similarity index 100%
rename from tk/ports.scm
rename to ports.scm
diff --git a/tk/short.scm b/short.scm
similarity index 100%
rename from tk/short.scm
rename to short.scm