env/README.md

28 lines
762 B
Markdown

# Shell goodies
A collection of shell enhancement for everyday happiness.
## Setup
```bash
git clone git@github.com:mcataford/env.git ~/.env_goodies | . ./setup
```
## Updating existing setups
Since `~/.env_goodies` is a cloned repository, pulling new changes should update everything. You may need to `source`
the shell configuration file again for new goodies to apply.
## Structure
The package is structured as such:
```
env/
setup # Adds bootstrap block to your shell's config file.
source/
... # Anything here is sourced on shell-start
```
Adding files to `source/` will add code that gets executed on shell-start. Files are discovered by globbing in the
bootstrap block added by `setup` and do not need to be registered anywhere.