bash-composition
A framework for bash initialisation, which encourages keeping many small configuration files that share common themes or purposes, rather than one big file with all of the things meshed together.
It also encourages borrowing other people's small configuration files, and easily knowing what changes they have made that you don't yet have.
Installing
Clone this repository, cd
into your checkout, and run
./script/update install
.
WARNING: This will overwrite your ~/.bashrc
and ~/.bash_profile
,
moving your original files to ~/.bashrc.bak
and ~/.bash_profile.bak
.
Updating
Any changes to this repo can be safely applied later by updating your local
checkout, and running ./script/update
again. Any local changes you have
made to these files will not be overwritten.
# install updates
./script/update
# if local changes, see what they are
./script/update diff
# force overwriting
./script/update install
Documentation
More documentation can be found in the share/bash-composition
folder:
- usage.markdown explains the general usage of the framework
- functions.markdown details what functions are provided
- prompt.markdown details macros available for more conveniently setting the prompt
Example personal customisation
See my homedir settings (what people often
call dotfiles
).