feat(.gitignore):Add ignore list
[BK-2020-03.git] / README.org
CommitLineData
2feb5df8
SBS
1* Baltakatei Executables Development
2#+TITLE: Baltakatei Executables Development
3#+AUTHOR: Steven Baltakatei Sandoval
4#+DATE:2021-03-04
5#+EMAIL:baltakatei@gmail.com
6#+LANGUAGE: en
7#+OPTIONS: toc:nil
8
9** Summary
10This repository contains publicly-sharable executables used by Steven
11Baltakatei Sandoval. produced by Steven Baltakatei Sandoval.
12
13** Directory Structure
cdd1f1a9
SBS
14*** ~archive~
15This directory contains files not actively used but useful for
16understanding long-term history of this project.
17
cdd1f1a9
SBS
18*** ~doc~
19This directory contains documentation about files in this project.
20
cdd1f1a9
SBS
21*** ~sysutils~
22This directory contains executable utilities meant to change operating
23system settings.
24
25An 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.
cdd1f1a9
SBS
29
30*** ~unitproc~
31This directory contains executables meant to process data produced by
32other executables for processing by other executables. It does NOT
33contain executables meant to change operating system settings.
34
35Example 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.
2feb5df8
SBS
46
47*** ~user~
48This directory contains executables meant to be regularly called
49directly by the user to perform one-off tasks.
50
51Examples 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.