Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
SkypLabs committed Nov 22, 2016
1 parent 909b578 commit fe25d17
Showing 1 changed file with 28 additions and 8 deletions.
36 changes: 28 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -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 <absolute path to BSFL>

Expand All @@ -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 <BSFL repository>/doc
doxygen Doxyfile

## Dependencies

BSFL is implemented for bash version 4. Prior versions of bash will fail at interpreting its code.
Expand All @@ -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 <BSFL repository>/test

Building the documentation is done by using Doxygen :
Or, to run only the tests of a specific group :

cd <path to BSFL repository>/doc
doxygen Doxyfile
bats <BSFL repository>/test/<test file>

For example, for the network group :

bats <BSFL repository>/test/network.bats

## Get involved !

Expand All @@ -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/

0 comments on commit fe25d17

Please sign in to comment.