From: Steven Baltakatei Sandoval Date: Wed, 13 Jan 2021 22:52:04 +0000 (+0000) Subject: doc(README.org):Add README and ABOUT files X-Git-Tag: 0.3.0~2 X-Git-Url: https://zdv2.bktei.com/gitweb/BK-2020-03.git/commitdiff_plain/cdd1f1a9ef8799e9ddd3d65009387db2fc9550b3?ds=inline;hp=--cc doc(README.org):Add README and ABOUT files --- cdd1f1a9ef8799e9ddd3d65009387db2fc9550b3 diff --git a/README.org b/README.org new file mode 100644 index 0000000..261cdf5 --- /dev/null +++ b/README.org @@ -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 index 0000000..0d4708e --- /dev/null +++ b/archive/ABOUT.org @@ -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 index 0000000..daf1584 --- /dev/null +++ b/doc/ABOUT.org @@ -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 index 0000000..370f13b --- /dev/null +++ b/sysutils/ABOUT.org @@ -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 index 0000000..ab1451d --- /dev/null +++ b/unitproc/ABOUT.org @@ -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.