Libqgit2

A Qt wrapper library around the libgit2 git access library

Install

This is a qtpm <https://github.com/qtpm/qtpm>_ package.

.. code-block:: bash

$ qtpm get github.com/qtpm/libqgit2

Headers and a library file are installed under vendor/include and vendor/lib directory.

Example

.. code-block:: cpp

#include <libqgit2/qgit2.h>

int main() { auto repository = new LibQGit2::Repository() try { repository->open(newPath); } catch (const LibQGit2::Exception& e) { qDebug() << e.message(); return 1; } qDebug() << repository->listReferences(); }

Reference

TBD

Develop

qtpm command helps your development.

.. code-block:: bash

$ git clone git@github.com:shibukawa.yoshiki/libqgit2.git $ cd libqgit2

Run the following command once if this package has required packages

-u updates modules they are already downloaded

$ qtpm get [-u]

Build and run test

$ qtpm test

Try install to vendor folder

$ qtpm build

Folder Structure and Naming Convention

.. code-block:: none

   + src/           // Header files under this folder will be published.
   |  |             // Don't add `main.cpp`. qtpm assumes this package is an application, not library.
   |  + private/    // Files under this folder will hide from outer modules.
   + resources/     // .qrc files are linked to application.
   + examples/      // Each .cpp file is build into executable.
   + test/          // Each _test.cpp file is built into executable and launched by qtpm test.
   |                // Use `qtpm add test`` to add test case.
   |                // Other .cpp files are used as utility code. They are linked to test modules.
   + doc/           // (not working yet) QDoc setting file and extra image files and so on.
   + html/          // (not working yet) HTML output of QDoc.
   + vendor/        // External libraries (source and binary)
   + build/         // Work folder.
   + CMakeExtra.txt // This file is included from created CMakeLists.txt.
                    // You can add any extra build options here.

Author
--------------

* Developer: Aki Koskinen, Leonardo Giordani
* KDE Project Manager: Laszlo Papp, Leonardo Giordani
* qtpm pakcaged by: Yoshiki Shibukawa

License
--------------

GNU Lesser General Public License (LGPL) v2.1"

History
--------------

* 3/14/2016: First working version