doc(README.org):Add README and ABOUT files
[BK-2020-03.git] / README.org
1 * Baltakatei Executable Development
2
3 The purpose of this project is to create and maintain executables
4 produced by Steven Baltakatei Sandoval.
5
6 ** Contents
7
8 *** ~archive~
9 This directory contains files not actively used but useful for
10 understanding long-term history of this project.
11
12
13 *** ~doc~
14 This directory contains documentation about files in this project.
15
16
17 *** ~sysutils~
18 This directory contains executable utilities meant to change operating
19 system settings.
20
21 An example executable to be stored here may include:
22
23 - A bash script that runs ~apt~ to configure a Debian GNU/Linux
24 machine to compile executable binaries from source.
25 - A bash script that appends the last modification date to a file name
26 would go here.
27
28
29 *** ~unitproc~
30 This directory contains executables meant to process data produced by
31 other executables for processing by other executables. It does NOT
32 contain executables meant to change operating system settings.
33
34 Example executables to be stored here may include:
35
36 - A file that belongs here is a python script containing a generally
37 useful function definition meant to be inserted into various larger
38 python scripts.
39 - A bash script meant to be regularly run by ~cron~ to perform an
40 ~rsync~ backup of the user's home directory, using option arguments
41 to specify a custom output directory to hold the backup files.
42 - A bash script that uses ~inotifywait~ to hash files immediately
43 after they are modified and log the hashes to an option-specified
44 path on disk.