README.org

   1 * Baltakatei Executables Development
   2 #+TITLE: Baltakatei Executables Development
   3 #+AUTHOR: Steven Baltakatei Sandoval
   4 #+DATE:2023-03-19
   5 #+EMAIL:baltakatei@gmail.com
   6 #+LANGUAGE: en
   7 #+OPTIONS: toc:nil
   8
   9 ** Summary
  10 This repository contains publicly-sharable executables produced by
  11 Steven Baltakatei Sandoval.
  12
  13 ** Directory Structure
  14 *** ~archive~
  15 This directory contains files not actively used but useful for
  16 understanding long-term history of this project.
  17
  18 *** ~doc~
  19 This directory contains documentation about files in this project.
  20
  21 *** ~sysutils~
  22 This directory contains executable utilities meant to change operating
  23 system settings.
  24
  25 An example executable to be stored here may include:
  26
  27 - A bash script that runs ~apt~ to configure a Debian GNU/Linux
  28   machine to compile executable binaries from source.
  29
  30 *** ~unitproc~
  31 This directory contains executables meant to process data produced by
  32 other executables for processing by other executables. It does NOT
  33 contain executables meant to change operating system settings.
  34
  35 Example executables to be stored here may include:
  36
  37 - A file that belongs here is a python script containing a generally
  38   useful function definition meant to be inserted into various larger
  39   python scripts.
  40 - A bash script meant to be regularly run by ~cron~ to perform an
  41   ~rsync~ backup of the user's home directory, using option arguments
  42   to specify a custom output directory to hold the backup files.
  43 - A bash script that uses ~inotifywait~ to hash files immediately
  44   after they are modified and log the hashes to an option-specified
  45   path on disk.
  46
  47 *** ~user~
  48 This directory contains executables meant to be regularly called
  49 directly by the user to perform one-off tasks.
  50
  51 Examples may include:
  52
  53 - A bash script that appends the last modification date to a file name
  54   would go here.
  55 - A bash script that compresses a file with custom compression
  56   settings.
  57 - A bash script that generates a random passphrase with a custom
  58   alphabet and adjustable entropy.
  59 - A bash script that initializes a multiwindow terminal emulator
  60   (i.e. ~tilix~) with custom initial working directories.
  61
  62 ** Metadata
  63 - Baltakatei Project No. ~BK-2020-03~
  64
  65 ** See Also
  66 - [[https://reboil.com/mediawiki/BK-2020-03:_Baltakatei_Executables_Development][Reboil.com wiki page]]