doc(README.org):Add README and ABOUT files
authorSteven Baltakatei Sandoval <baltakatei@gmail.com>
Wed, 13 Jan 2021 22:52:04 +0000 (22:52 +0000)
committerSteven Baltakatei Sandoval <baltakatei@gmail.com>
Wed, 13 Jan 2021 22:52:04 +0000 (22:52 +0000)
README.org [new file with mode: 0644]
archive/ABOUT.org [new file with mode: 0644]
doc/ABOUT.org [new file with mode: 0644]
sysutils/ABOUT.org [new file with mode: 0644]
unitproc/ABOUT.org [new file with mode: 0644]

diff --git a/README.org b/README.org
new file mode 100644 (file)
index 0000000..261cdf5
--- /dev/null
@@ -0,0 +1,44 @@
+* Baltakatei Executable Development
+
+The purpose of this project is to create and maintain executables
+produced by Steven Baltakatei Sandoval.
+
+** Contents
+
+*** ~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.
+
+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
+other executables for processing by other executables. It does NOT
+contain executables meant to change operating system settings.
+
+Example executables to be stored here may include:
+
+- A file that belongs here is a python script containing a generally
+  useful function definition meant to be inserted into various larger
+  python scripts.
+- A bash script meant to be regularly run by ~cron~ to perform an
+  ~rsync~ backup of the user's home directory, using option arguments
+  to specify a custom output directory to hold the backup files.
+- 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.
diff --git a/archive/ABOUT.org b/archive/ABOUT.org
new file mode 100644 (file)
index 0000000..0d4708e
--- /dev/null
@@ -0,0 +1,4 @@
+* ABOUT ~archive~
+
+This directory contains files not actively used but useful for
+understanding long-term history of this project.
diff --git a/doc/ABOUT.org b/doc/ABOUT.org
new file mode 100644 (file)
index 0000000..daf1584
--- /dev/null
@@ -0,0 +1,3 @@
+* ABOUT ~doc~
+
+This directory contains documentation about this project.
diff --git a/sysutils/ABOUT.org b/sysutils/ABOUT.org
new file mode 100644 (file)
index 0000000..370f13b
--- /dev/null
@@ -0,0 +1,4 @@
+* ABOUT ~sysutils~
+
+This directory contains executable utilities meant to change operating
+system settings.
diff --git a/unitproc/ABOUT.org b/unitproc/ABOUT.org
new file mode 100644 (file)
index 0000000..ab1451d
--- /dev/null
@@ -0,0 +1,5 @@
+* ABOUT ~unitproc~
+
+This directory contains executables meant to process data produced by
+other executables for processing by other executables. It does NOT
+contain executables meant to change operating system settings.