bash3boilerplate/README.md

36 lines
1.1 KiB
Markdown
Raw Normal View History

2013-02-25 22:54:34 +00:00
When hacking up BASH scripts, I often find there are some
2013-02-25 22:39:31 +00:00
higherlevel things like logging, configuration, commandline argument
2013-02-25 22:54:34 +00:00
parsing that:
2013-02-25 22:39:31 +00:00
- I need everytime
2013-02-25 22:54:34 +00:00
- Take quite some effort to get right
- Keep you from your actual work
2013-02-25 22:39:31 +00:00
Here's an attempt to bundle those things in a generalized way so that
they are reusable as-is in most of my (and hopefully your, if not ping
me) programs.
2013-02-25 23:30:30 +00:00
An up to date [intro is found on my blog](http://kvz.io/blog/2013/02/26/introducing-bash3boilerplate/).
2013-02-25 22:39:31 +00:00
2013-02-25 23:30:30 +00:00
## Versioning
2013-02-25 22:39:31 +00:00
2013-03-27 15:05:58 +00:00
This project implements the Semantic Versioning guidelines.
2013-02-25 22:39:31 +00:00
2013-02-25 23:30:30 +00:00
Releases will be numbered with the following format:
2013-02-25 22:39:31 +00:00
2013-02-25 23:30:30 +00:00
`<major>.<minor>.<patch>`
2013-02-25 22:39:31 +00:00
2013-02-25 23:30:30 +00:00
And constructed with the following guidelines:
2013-02-25 22:39:31 +00:00
2013-02-25 23:30:30 +00:00
* Breaking backward compatibility bumps the major (and resets the minor and patch)
* New additions without breaking backward compatibility bumps the minor (and resets the patch)
* Bug fixes and misc changes bumps the patch
2013-02-25 22:39:31 +00:00
2013-03-27 16:54:31 +00:00
For more information on SemVer, please visit [http://semver.org](http://semver.org).
2013-03-27 15:08:31 +00:00
## License
2013-03-27 16:56:19 +00:00
Copyright (c) 2013 Kevin van Zonneveld, [http://kvz.io](http://kvz.io)
2013-03-27 16:54:31 +00:00
Licensed under MIT: [http://kvz.mit-license.org](http://kvz.mit-license.org)