Library installation

Installing the library in your system or a local package directory means to copy at least two files in concerned directory:

• piwi-bash-library.bash : the library source itself
• piwi-bash-library.man : the manual page of the library

You can install the package in many ways explained below ; the best practice is to use the internal interface as it presents facilities to update the library.

Classic installation

Once you have downloaded or cloned the package sources, just copy the bin/piwi-bash-library.bash file to your project directory and begin to use it ... We recommend to also copy the library's manpage man/piwi-bash-library.man in the same directory.

For a global usage on your machine, you can copy the library in your bin/ directory.

As for any script file, it must have execution rights for all users.

A direct and complete installation, including downloading sources, could be:

wget --no-check-certificate http://github.com/piwi/bash-library/archive/master.tar.gz
tar -xvf master.tar.gz
cp piwi-bash-library-master/bin/piwi-bash-library.bash path/to/your/project/bin/
cp piwi-bash-library-master/man/piwi-bash-library.man path/to/your/project/bin/
chmod a+x path/to/your/project/bin/piwi-bash-library.bash
man path/to/your/project/bin/piwi-bash-library.man

Internal interface

The library embeds an internal interface to manage (install/update/uninstall) the library itself locally or globally. To use it, run:

path/to/piwi-bash-library.bash help

You can specify the path to install the library with the --target=PATH option. By Default, it will be installed in your $HOME/bin/ directory.

For a developer user installation, you can use the --preset=full option which will also install the following files:

• piwi-bash-library-DOC.md : the development documentation of your current library
• piwi-bash-library-README.md : a copy of the global "README.md" file of the package

It is sometimes useful to include the library file to your project and manage it manually under version control. The interface will handle the installation and update of the library files for you.

A direct and complete installation, including downloading sources, could be:

wget --no-check-certificate http://github.com/piwi/bash-library/archive/master.tar.gz
tar -xvf master.tar.gz
./piwi-bash-library-master/bin/piwi-bash-library.bash install