Permalink
Switch branches/tags
Nothing to show
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
106 lines (71 sloc) 2.73 KB

Welcome to Jaguar - PHP Graphic Library's documentation!

Jaguar is a PHP5.3 OOP graphic library was built on the Great GD Library using the best practices to build a stable and fast layer for image manipulation and drawing.

Something to mention

Jaguar was built on php gd extension and this extension is so famous with its "limitations" in the php community like memory and transparent problems for example.

Thats's what Jaguar is for , overcome those "limitations" and let the programmer focus on the his/her application logic instead of spending hours trying to solve image transparent problem for example and finally moving to photoshop to solve the problem.

Installation

Installation via composer

Simply add a dependency on hyyan/jaguar to your project's composer.json file. Here is a minimal example of a composer.json file that just defines a development-time dependency on Jaguar 1.0:

{
        "require-dev": {
                "hyyan/jaguar": "1.0.*"
        }
}

For a system-wide installation via Composer, you can run:

composer global require 'hyyan/jaguar=1.0.*'

Note

Make sure you have ~/.composer/vendor/bin/ in your path If you choosed the system-wide installation.

Contribute

Your contributions are more than welcome !

Start by forking Jaguar repository, write your feature, fix bugs, and send a pull request. If you modify Jaguar API, please update the API documentation in the Jaguar Docs repository

Note

Jaguar uses ApiGen project as documentation generator . take a look at the ApiGen project

You can update API documentation by running :

$ git clone http://www.github.com/hyyan/jaguar-docs
$ cd jaguar-docs
$ apigen --config="./aguar-apigen.neon"
           --template-config="path/to/apigen/templates/bootstrap/config.neon"

Note

Jaguar follows the Symfony standards If you’re a beginner, you will find some guidelines about code contributions at Symfony.

API

Jaguar API is available here.

.. toctree::
   :maxdepth: 3

   usage/Geometry System
   usage/Colors
   usage/Canvas
   usage/Drawables
   usage/Gradients
   usage/Actions

Indices and tables