Toolbox library for the planted aquarium
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
data
src
tests
.editorconfig
.gitignore
.travis.yml
LICENSE
README.md
apigen.neon
composer.json
composer.lock
phpunit.xml.dist

README.md

aquarium-toolbox

Build Status codecov

This library can do typical calculations used in planted aquariums, like fertilizer dosings.

It's based on the excelent ideas and data of the late Carlo Flores' yet-another-nutrient-calculator.

The goals for this project are simplicity, reusability and reliablity.

Requirements

  • PHP 5.4+

How to use it

You can install this library using composer.

# composer.phar require berarma/aquarium-toolbox

Documentation

To generate documentation you need to have ApiGen installed or install Composer dependencies with command:

# composer.phar install

Run ApiGen:

# vendor/bin/apigen generate

Open docs/index.html in your browser.

License

This software is licensed under the GPL v2 license. This is a library, you're just required to share your modifications/fixes/improvements to it. You aren't required to relicense your own projects because you're using and/or redistributing this software with them.

Disclaimer

There's no warranty of any kind, you're the sole responsible for the use or misuse of this software.