https://github.com/norm/bash-composition
A framework for bash initialisation scripts
https://github.com/norm/bash-composition
Last synced: about 1 year ago
JSON representation
A framework for bash initialisation scripts
- Host: GitHub
- URL: https://github.com/norm/bash-composition
- Owner: norm
- Created: 2013-11-16T08:08:28.000Z (over 12 years ago)
- Default Branch: main
- Last Pushed: 2022-02-01T06:28:17.000Z (over 4 years ago)
- Last Synced: 2025-03-23T20:11:33.677Z (over 1 year ago)
- Language: Shell
- Size: 38.1 KB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.markdown
Awesome Lists containing this project
README
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][usage] explains the general usage of the framework
* [functions.markdown][functions] details what functions are provided
* [prompt.markdown][prompt] details macros available for more conveniently
setting the prompt
[usage]: https://github.com/norm/bash-composition/blob/master/share/bash-composition/usage.markdown
[functions]: https://github.com/norm/bash-composition/blob/master/share/bash-composition/functions.markdown
[prompt]: https://github.com/norm/bash-composition/blob/master/share/bash-composition/prompt.markdown
## Example personal customisation
See my [homedir settings](https://github.com/norm/homedir) (what people often
call `dotfiles`).