From 39ed8c4da1df1783cd575bda14f2c12fb8d0cdea Mon Sep 17 00:00:00 2001 From: Dan Wendorf Date: Tue, 18 Jul 2017 08:47:12 -0700 Subject: [PATCH] Explicitly mention Bash 3.2 compatibility Bash-it previously did not specify compatibility with any particular Bash version, but uses features in Bash 3.2 (like omitting quoting for =~ expressions) while ignoring features in Bash 4 (like associative arrays). By explicitly mentioning the minimum supported version, it is easier for contributors to understand which shell features are usable. --- CONTRIBUTING.md | 1 + README.md | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9c365a75..5600fa31 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -24,6 +24,7 @@ When contributing a new feature, a bug fix, a new theme, or any other change to * Use the provided meta functions to document your code, e.g. `about-plugin`, `about`, `group`, `param`, `example`. This will make it easier for other people to use your new functionality. Take a look at the existing code for an example (e.g. [the base plugin](plugins/available/base.plugin.bash)). * When adding files, please use the existing file naming conventions, e.g. plugin files need to end in `.plugin.bash`. This is important for the installation functionality. * When using the `$BASH_IT` variable, please always enclose it in double quotes to ensure that the code also works when Bash-it is installed in a directory that contains spaces in its name: `for f in "${BASH_IT}/plugins/available"/*.bash ; do echo "$f" ; done` +* Bash-it supports Bash 3.2 and higher. Please don't use features only available in Bash 4, such as associative arrays. ## Unit Tests diff --git a/README.md b/README.md index 47f546da..bf3ead50 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![Build Status](https://travis-ci.org/Bash-it/bash-it.svg?branch=master)](https://travis-ci.org/Bash-it/bash-it) [![Join the chat at https://gitter.im/Bash-it/bash-it](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/Bash-it/bash-it?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) -**Bash-it** is a collection of community Bash commands and scripts. (And a shameless ripoff of [oh-my-zsh](https://github.com/robbyrussell/oh-my-zsh) :smiley:) +**Bash-it** is a collection of community Bash commands and scripts for Bash 3.2+. (And a shameless ripoff of [oh-my-zsh](https://github.com/robbyrussell/oh-my-zsh) :smiley:) Includes autocompletion, themes, aliases, custom functions, a few stolen pieces from Steve Losh, and more.