summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorbill-auger <mr.j.spam.me@gmail.com>2022-08-17 07:17:25 -0400
committerbill-auger <mr.j.spam.me@gmail.com>2022-08-17 08:00:19 -0400
commit6e627e7913580d9742cf008e305cbc12515f15f7 (patch)
tree69532ad133283d3f93486e7234c3fa94620ed2eb
parent89bee2d1cfde6f60779842c4657578bff2dab903 (diff)
restore README
-rw-r--r--.gitignore1
-rw-r--r--README62
2 files changed, 63 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore
index b13f1fa..3f076a1 100644
--- a/.gitignore
+++ b/.gitignore
@@ -9,6 +9,7 @@
!KEYMAPS_X
!LANGUAGES
!pacman.conf
+!README
!session-common.sh.inc
!session-init.sh
!translations.sh.inc
diff --git a/README b/README
new file mode 100644
index 0000000..1fc0650
--- /dev/null
+++ b/README
@@ -0,0 +1,62 @@
+
+flow of dialogs/user-interactions:
+ -----------------------------------------------------------------------------------------
+ | LEGEND |
+ |---------------------------------------------------------------------------------------|
+ | entry-point: | FunctionName() | function name |
+ | entry-point: | FunctionName()->[STATE_VAR] | function setting state var(s) implicitly |
+ | prompt: | ->[STATE_VAR]* | prompt setting state var(s) |
+ | prompt: | ->translation_key | prompt setting no state var(s) |
+ | prompt: | ->`external_program` | prompt launching an interactive program |
+ | antecedent: | ?_resp | switch on user response |
+ | antecedent: | ?_[STATE_VAR]* | switch on state var(s) |
+ | consequent: | -->FunctionName | proceed to next function |
+ |----------------------------------------------------------------------------------------
+ | NoticeIntro() | Init()->[INSTALL][KEYRING] |
+ | -->Init | -->SelectLogins |
+ |--------------------------------------------------------------------------------|
+ | SelectLogins() | NoticeCustomize() |
+ | ->ROOT_PASS | -->SelectDefaults |
+ | ->dlg_user-* | |
+ | ?_yes | |
+ | ->USER_LOGIN | |
+ | ->USER_PASS-->NoticeCustomize | |
+ | ?_no----------->NoticeCustomize | |
+ |-------------------------------------|------------------------------------------|
+ | SelectDefaults() | SelectPartition() |
+ | ->[INSTALL]&[BASE]&[INIT] | ->DEVICE |
+ | [WMDE] | ->PART_METHOD |
+ | [HOSTNAME]&[TIMEZONE]&[KEYMAP]& | ?_auto---->SelectBoot |
+ | [LOCALES]&[LANGUAGE] | ?_manual-->SelectBoot |
+ | ?_yes-->SelectPartition | |
+ | ?_no--->SelectPartition | |
+ |-------------------------------------|------------------------------------------|
+ | SelectBoot() | SelectBase() |
+ | ->BOOT | ?_[INSTALL]&[BASE]&[INIT]-->SelectWmde |
+ | ?_grub-->NoticeReady | ->INSTALL |
+ | ?_none-->NoticeReady | ->BASE |
+ | | ->INIT--------------------->SelectWmde |
+ |-------------------------------------|------------------------------------------|
+ | SelectWmde()->[WMDE] | SelectEnv() |
+ | ?_[WMDE]-->SelectEnv | ?_[HOSTNAME]&[TIMEZONE]&[KEYMAP]& |
+ | ->dlg_wmde | [LOCALES]&[LANGUAGE]-->NoticeReady |
+ | ?_yes | ->HOSTNAME |
+ | ->WMDE-->SelectEnv | ->TIMEZONE |
+ | ?_no------>SelectEnv | ->KEYMAP |
+ | | ->LOCALES |
+ | | ->LANGUAGE-->NoticeReady |
+ |-------------------------------------|------------------------------------------|
+ | NoticeReady() | Partition() |
+ | -->Partition | ?_[PART_METHOD:auto]-->InstallPkgs |
+ | | ?_[PART_METHOD:manual] |
+ | | ->`partitioner` |
+ | | ->ROOT_PART |
+ | | ->BOOT_PART |
+ | | ->HOME_PART--------->InstallPkgs |
+ |-------------------------------------|------------------------------------------|
+ | InstallPkgs() | ConfigChroot() |
+ | -->ConfigChroot | -->NoticeDone |
+ |-------------------------------------|------------------------------------------|
+ | NoticeDone() | Cleanup() |
+ | -->Cleanup | -->exit |
+ ----------------------------------------------------------------------------------