bzsolt / gepard

Gepard - HW accelerated 2D engine

GEPARD

The Gepard aims to be a hardware accelerated 2D rendering engine.

Aside from the main goal (that is hardware accelerated) we aim to create an engine which is:

• lightweight: as there should be only rendering related part in the code.
• modular/configurability: provide configuration options where the developer can specify which part is needed.

Getting Started

Check out the source code

git clone https://github.com/GepardGraphics/gepard.git

Install any necessary dependencies

./tools/scripts/install-deps.sh

Build gepard dynamic library

./tools/scripts/build.py

Build & run examples

Build all examples in ./example

./tools/scripts/build.py -e   # release mode
./tools/scripts/build.py -ed  # debug mode

Run an example (now the fill-rect)

./build/release/bin/fill-rect   # release mode
./build/debug/bin/fill-rect     # debug mode

For developers

Contribution to the project is done by using the fork model. ([GitHub help] (https://help.github.com/articles/working-with-forks/))

After you fork and clone the Gepard repository, you will need to install more dependencies for contributing.

./tools/scripts/install-deps.sh --developer

If you are looking for easy tasks, please check the low hanging fruits (LHF). Otherwise, feel free to browse other issues as well.

Our contributing process is:

1. Create a branch with a name like: fix-min-compute, 15-canvas2d-path, etc.

   git checkout -b my-first-patch
   

   Note: About the branch naming in Gepard. If you work on an issue, then it is recommended to start your branchname with the issue number.

2. Create your patch.

   Note: Please use sign-off in every commits. Git usage: git commit -s|--sign-off (https://git-scm.com/docs/git-commit).

3. If you are ready, create a Pull request (PR) to the GepardGraphics/gepard/master. (If you know a reviewer who works on that topic, then you should assign her/him, otherwise leave it unassigned.)

4. Your PR will be approved if you get 2 lgtm-s from the reviewers.

For more information see the wiki page's 'For contributors' section.