README.md

   1 libgit2 - the Git linkable library
   2 ======================
   3
   4 libgit2 is a portable, pure C implementation of the Git core methods provided as a
   5 re-entrant linkable library with a solid API, allowing you to write native
   6 speed custom Git applications in any language with bindings.
   7
   8 libgit2 is licensed under a **very permissive license** (GPLv2 with a special Linking Exception).
   9 This basically means that you can link it (unmodified) with any kind of software without having to
  10 release its source code.
  11
  12 * Mailing list: <libgit2@librelist.org>
  13     * Archives: <http://librelist.com/browser/libgit2/>
  14 * Website: <http://libgit2.github.com>
  15 * API documentation: <http://libgit2.github.com/libgit2>
  16 * Usage guide: <http://libgit2.github.com/api.html>
  17
  18 What It Can Do
  19 ==================================
  20
  21 libgit2 is already very usable.
  22
  23 * SHA conversions, formatting and shortening
  24 * abstracted ODB backend system
  25 * commit, tag, tree and blob parsing, editing, and write-back
  26 * tree traversal
  27 * revision walking
  28 * index file (staging area) manipulation
  29 * reference management (including packed references)
  30 * config file management
  31 * high level repository management
  32 * thread safety and reentrancy
  33 * descriptive and detailed error messages
  34 * ...and more (over 175 different API calls)
  35
  36 Building libgit2 - Using CMake
  37 ==============================
  38
  39 libgit2 builds cleanly on most platforms without any external dependencies.
  40 Under Unix-like systems, like Linux, \*BSD and Mac OS X, libgit2 expects `pthreads` to be available;
  41 they should be installed by default on all systems. Under Windows, libgit2 uses the native Windows API
  42 for threading.
  43
  44 The libgit2 library is built using CMake 2.6+ (<http://www.cmake.org>) on all platforms.
  45
  46 On most systems you can build the library using the following commands
  47
  48         $ mkdir build && cd build
  49         $ cmake ..
  50         $ cmake --build .
  51
  52 Alternatively you can point the CMake GUI tool to the CMakeLists.txt file and generate platform specific build project or IDE workspace.
  53
  54 To install the library you can specify the install prefix by setting:
  55
  56         $ cmake .. -DCMAKE_INSTALL_PREFIX=/install/prefix
  57         $ cmake --build . --target install
  58
  59 If you want to build a universal binary for Mac OS X, CMake sets it
  60 all up for you if you use `-DCMAKE_OSX_ARCHITECTURES="i386;x86_64"`
  61 when configuring.
  62
  63 For more advanced use or questions about CMake please read <http://www.cmake.org/Wiki/CMake_FAQ>.
  64
  65 The following CMake variables are declared:
  66
  67 - `INSTALL_BIN`: Where to install binaries to.
  68 - `INSTALL_LIB`: Where to install libraries to.
  69 - `INSTALL_INC`: Where to install headers to.
  70 - `BUILD_SHARED_LIBS`: Build libgit2 as a Shared Library (defaults to ON)
  71 - `BUILD_TESTS`: Build the libgit2 test suite (defaults to ON)
  72 - `THREADSAFE`: Build libgit2 with threading support (defaults to OFF)
  73
  74 Language Bindings
  75 ==================================
  76
  77 Here are the bindings to libgit2 that are currently available:
  78
  79 * C++
  80     * libqgit2, Qt bindings <https://projects.kde.org/projects/playground/libs/libqgit2/>
  81 * Delphi
  82     * GitForDelphi <https://github.com/libgit2/GitForDelphi>
  83 * Erlang
  84     * Geef <https://github.com/schacon/geef>
  85 * Go
  86     * go-git <https://github.com/str1ngs/go-git>
  87 * GObject
  88     * libgit2-glib <https://github.com/nacho/libgit2-glib>
  89 * Haskell
  90     * hgit2 <https://github.com/norm2782/hgit2>
  91 * Lua
  92     * luagit2 <https://github.com/libgit2/luagit2>
  93 * .NET
  94     * libgit2net, low level bindings <https://github.com/txdv/libgit2net>
  95     * libgit2sharp <https://github.com/libgit2/libgit2sharp>
  96 * Node.js
  97     * node-gitteh <https://github.com/libgit2/node-gitteh>
  98     * nodegit <https://github.com/tbranyen/nodegit>
  99 * Objective-C
 100     * objective-git <https://github.com/libgit2/objective-git>
 101 * OCaml
 102     * libgit2-ocaml <https://github.com/burdges/libgit2-ocaml>
 103 * Parrot Virtual Machine
 104     * parrot-libgit2 <https://github.com/letolabs/parrot-libgit2>
 105 * Perl
 106     * git-xs-pm <https://github.com/ingydotnet/git-xs-pm>
 107 * PHP
 108     * php-git <https://github.com/libgit2/php-git>
 109 * Python
 110     * pygit2 <https://github.com/libgit2/pygit2>
 111 * Ruby
 112     * Rugged <https://github.com/libgit2/rugged>
 113 * Vala
 114     * libgit2.vapi <https://github.com/apmasell/vapis/blob/master/libgit2.vapi>
 115
 116 If you start another language binding to libgit2, please let us know so
 117 we can add it to the list.
 118
 119 How Can I Contribute?
 120 ==================================
 121
 122 Fork libgit2/libgit2 on GitHub, add your improvement, push it to a branch
 123 in your fork named for the topic, send a pull request.
 124
 125 You can also file bugs or feature requests under the libgit2 project on
 126 GitHub, or join us on the mailing list by sending an email to:
 127
 128 libgit2@librelist.com
 129
 130
 131 License
 132 ==================================
 133 libgit2 is under GPL2 **with linking exemption**. This means you
 134 can link to the library with any program, commercial, open source or
 135 other.  However, you cannot modify libgit2 and distribute it without
 136 supplying the source.
 137
 138 See the COPYING file for the full license text.