From eff28920e83342a03a35ebd45bf0dc16d7db9825 Mon Sep 17 00:00:00 2001 From: Marc Cataford Date: Sun, 28 Jan 2024 11:01:36 -0500 Subject: [PATCH] docs: update notes on steps --- README.md | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 72fbb97..3d1b64a 100644 --- a/README.md +++ b/README.md @@ -22,13 +22,20 @@ The package is structured as such: ``` env/ - bootstrap.sh # Adds bootstrap block to your shell's config file. - shell_extras # Functions, aliases and exports for the shell. - extras.vim # Common config for NVIM. + bootstrap.sh # Adds bootstrap block to your shell's config file. + steps.sh # Definitions for bootstrapping steps + shell_extras # Functions, aliases and exports for the shell. + extras.vim # Common config for NVIM. ``` Adding code to `shell_extras` will add code that gets executed on shell-start. +### Adding steps + +Each step is defined as a function in `steps.sh` and should start with a call to `pre_step` to ensure that a header gets +echo'ed out. Additionally, the function should be called from `bootstrap` in `bootstrap.sh` and the `TOTAL_STEPS` should +be updated to reflect the number of steps. + ## Contributing I'm not currently looking for contributions since this is mainly about standardizing my own setup across machines.