diff --git a/README.md b/README.md index 37e7bc6..bacf15b 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,38 @@ # OwlTestRunner -A test runner for it's usage for testing C. \ No newline at end of file +A test runner for it's usage for testing C. + +## Requirements + +### Gentoo + +```shell +sudo emerge -a sys-libs/db +``` + +### Debian-like + +```shell +sudo apt update +sudo apt install libdb-dev +``` + +## Installing + +Clone this repo and cd into the cloned directory and run: + +```shell +cpan . +``` + +If it is the first time using cpan it will prompt you to some questions about +how do you want to setup cpan. + +If you choose local::lib, after answering them restart your shell or +source ~/.bashrc, if using a non-bash shell you may have to add manually the +appropiate environment variables to your shell's rc, you can get those by issuing the +following command: + +```shell +PERL5LIB="$HOME/perl5/lib/perl5" perl -Mlocal::lib +```