Moving to be a subtree

README.md

@@ -1,17 +1,21 @@
-# Guile Schemeing
+# tk
-The purpose of this repository is to hold various small utilities I commonly
+tk is my Guile toolkit.     
-use in Scheme. Running `make; sudo make install` in the tk direcory will install
+Each unit contains a group of tools I commonly used together or with a
-sources to the Guile `(%site-dir)` and compiled .go files to the Guile
+particular module.
-`(%site-ccache-dir)`. All modules are installed under the prefix `tk/`
+
+`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!)`