marc/env
1
0
Fork 0
Code Pull requests Activity Actions

docs: update notes on steps

Browse source
This commit is contained in:
Marc 2024-01-28 11:01:36 -05:00
parent 1abade9e53
commit eff28920e8
Signed by: marc
GPG key ID: 048E042F22B5DC79
1 changed files with 10 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -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.