ExternalVendorCode/bash3boilerplate
1
0
Fork 0
mirror of https://github.com/kvz/bash3boilerplate.git synced 2024-12-24 08:36:37 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Elaborate on what portability really means for us

Browse Source
This commit is contained in:
Kevin van Zonneveld 2016-06-23 10:07:58 +02:00
parent 2b3ee1d195
commit 1f2e1842b3
2 changed files with 14 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
FAQ.md
View File

@ -104,3 +104,17 @@ The source mainly consists of:
The rest is dark magic you should probably steer clear from : ) The rest is dark magic you should probably steer clear from : )
Any changes should be proposed as PRs. Anything added to `master` is automatically deployed using a combination of Travis CI and GitHub Pages. Any changes should be proposed as PRs. Anything added to `master` is automatically deployed using a combination of Travis CI and GitHub Pages.
## You're saying you are portable - why won't b3bp code run in dash / busybox / posh / ksh / mksh / zsh?
When we say _portable_, we mean across Bash versions. Bash is widespread and most systems
offer at least version 3 of it. Make sure you have that available, and b3bp will work for you.
We run automated tests to make sure that it will, here's proof for the following platforms:
- [Linux](https://travis-ci.org/kvz/bash3boilerplate/jobs/109804166#L91) `GNU bash, version 4.2.25(1)-release (x86_64-pc-linux-gnu)`
- [OSX](https://travis-ci.org/kvz/bash3boilerplate/jobs/109804167#L2453) `GNU bash, version 3.2.51(1)-release (x86_64-apple-darwin13)`
This portability however does not mean we try to be compatible with
KornShell, Zsh, posh, yash, dash or other shells. We allow syntax that would explode if
you pasted it in anything but Bash 3 and up.

5
README.md
View File

@ -38,11 +38,6 @@ with 3 for instance). If you're going to ask people to install
Bash 4 first, you might as well pick a more advanced language as a Bash 4 first, you might as well pick a more advanced language as a
dependency. dependency.
We're automatically testing BASH3 Boilerplate and it's proven to work on:
- [Linux](https://travis-ci.org/kvz/bash3boilerplate/jobs/109804166#L91) `GNU bash, version 4.2.25(1)-release (x86_64-pc-linux-gnu)`
- [OSX](https://travis-ci.org/kvz/bash3boilerplate/jobs/109804167#L2453) `GNU bash, version 3.2.51(1)-release (x86_64-apple-darwin13)`
## Features ## Features
- Conventions so that after a while, all your scripts will follow the same, battle-tested structure - Conventions so that after a while, all your scripts will follow the same, battle-tested structure