diff --git a/README.md b/README.md index 038d98a..502106e 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,14 @@ # BSFL +[![Build Status](https://travis-ci.org/SkypLabs/bsfl.svg?branch=master)](https://travis-ci.org/SkypLabs/bsfl) + The Bash Shell Function Library (BSFL) is a small bash script that acts as a library for bash scripts. It provides a couple of functions that makes the lives of most people using shell scripts a bit easier. This project is a fork of the original work of Louwrentius. ## Getting started -In order to use BSFL functions, you have to include the library in your bash scripts. You can do it with an absolute path : +In order to use BSFL, you have to include the library in your bash scripts. You can do it with an absolute path : source @@ -24,6 +26,19 @@ For example : declare -r DIR=$(cd "$(dirname "$0")" && pwd) source $DIR/../lib/bsfl.sh +## What's next ? + +The best way to learn how BSFL works is to look at the examples available in the [examples][2] folder. + +## Documentation + +The online documentation is available [here][3]. + +Building the documentation is done by using [Doxygen][5] : + + cd /doc + doxygen Doxyfile + ## Dependencies BSFL is implemented for bash version 4. Prior versions of bash will fail at interpreting its code. @@ -40,18 +55,21 @@ In addition, BSFL depends of some external programs. Here is the list of these p However, we try to get as much as possible a standalone library. Hence, some of these external dependencies will be removed in the future. -## What's next ? +## Unit tests -The best way to learn how does BSFL work is to look at the examples available in the [examples][2] folder. +BSFL uses [Bats][4] testing framework to verify the correct behaviour of its functions. -## Documentation +To run all the tests : -The documentation is available online [here][3]. + bats /test -Building the documentation is done by using Doxygen : +Or, to run only the tests of a specific group : - cd /doc - doxygen Doxyfile + bats /test/ + +For example, for the network group : + + bats /test/network.bats ## Get involved ! @@ -64,3 +82,5 @@ This project is still under development. Contributions are welcomed. [1]: http://opensource.org/licenses/BSD-3-Clause [2]: https://github.com/SkypLabs/bsfl/tree/master/examples [3]: http://skyplabs.github.io/bsfl + [4]: https://github.com/sstephenson/bats + [5]: http://doxygen.org/