Merge branch 'master' of https://zdv2.bktei.com/gitweb/baltakatei-exdev into develop

[BK-2020-03.git] / README.org

diff --git a/README.org b/README.org
index 261cdf568eeba261211eb5914884154b60aa269d..943649e18de07fd2f4186673d2aecf166b39cfdf 100644 (file)
--- a/README.org
+++ b/README.org
@@ -1,19 +1,23 @@
-* Baltakatei Executable Development
-
-The purpose of this project is to create and maintain executables
-produced by Steven Baltakatei Sandoval.
-
-** Contents
-
+* Baltakatei Executables Development
+#+TITLE: Baltakatei Executables Development
+#+AUTHOR: Steven Baltakatei Sandoval
+#+DATE:2021-03-04
+#+EMAIL:baltakatei@gmail.com
+#+LANGUAGE: en
+#+OPTIONS: toc:nil
+
+** Summary
+This repository contains publicly-sharable executables used by Steven
+Baltakatei Sandoval.  produced by Steven Baltakatei Sandoval.
+
+** Directory Structure
 *** ~archive~
 This directory contains files not actively used but useful for
 understanding long-term history of this project.
 
-
 *** ~doc~
 This directory contains documentation about files in this project.
 
-
 *** ~sysutils~
 This directory contains executable utilities meant to change operating
 system settings.
@@ -22,9 +26,6 @@ An example executable to be stored here may include:
 
 - A bash script that runs ~apt~ to configure a Debian GNU/Linux
   machine to compile executable binaries from source.
-- A bash script that appends the last modification date to a file name
-  would go here.
-
 
 *** ~unitproc~
 This directory contains executables meant to process data produced by
@@ -42,3 +43,18 @@ Example executables to be stored here may include:
 - A bash script that uses ~inotifywait~ to hash files immediately
   after they are modified and log the hashes to an option-specified
   path on disk.
+
+*** ~user~
+This directory contains executables meant to be regularly called
+directly by the user to perform one-off tasks.
+
+Examples may include:
+
+- A bash script that appends the last modification date to a file name
+  would go here.
+- A bash script that compresses a file with custom compression
+  settings.
+- A bash script that generates a random passphrase with a custom
+  alphabet and adjustable entropy.
+- A bash script that initializes a multiwindow terminal emulator
+  (i.e. ~tilix~) with custom initial working directories.