README.md 6.37 KB
Newer Older
Scott Chacon committed
1
libgit2 - the Git linkable library
2
======================
Scott Chacon committed
3

4 5
[![Build Status](https://secure.travis-ci.org/libgit2/libgit2.png?branch=development)](http://travis-ci.org/libgit2/libgit2)

Scott Chacon committed
6 7 8 9
libgit2 is a portable, pure C implementation of the Git core methods provided as a
re-entrant linkable library with a solid API, allowing you to write native
speed custom Git applications in any language with bindings.

10 11 12 13
libgit2 is licensed under a **very permissive license** (GPLv2 with a special Linking Exception).
This basically means that you can link it (unmodified) with any kind of software without having to
release its source code.

14 15 16 17 18
* Mailing list: ~~<libgit2@librelist.org>~~
    The libgit2 mailing list has
    traditionally been hosted in Librelist, but Librelist is and has always
    been a shitshow. We encourage you to [open an issue](https://github.com/libgit2/libgit2/issues)
    on GitHub instead for any questions regarding the library.
19
    * Archives: <http://librelist.com/browser/libgit2/>
Vicent Marti committed
20
* Website: <http://libgit2.github.com>
21
* API documentation: <http://libgit2.github.com/libgit2>
Scott Chacon committed
22 23 24 25 26

What It Can Do
==================================

libgit2 is already very usable.
27

28
* SHA conversions, formatting and shortening
29
* abstracted ODB backend system
Vicent Marti committed
30
* commit, tag, tree and blob parsing, editing, and write-back
Scott Chacon committed
31
* tree traversal
32 33 34
* revision walking
* index file (staging area) manipulation
* reference management (including packed references)
Vicent Marti committed
35 36 37 38 39
* config file management
* high level repository management
* thread safety and reentrancy
* descriptive and detailed error messages
* ...and more (over 175 different API calls)
40

Vicent Marti committed
41 42
Building libgit2 - Using CMake
==============================
Peter Drahoš committed
43

44
libgit2 builds cleanly on most platforms without any external dependencies.
45
Under Unix-like systems, like Linux, \*BSD and Mac OS X, libgit2 expects `pthreads` to be available;
46 47 48
they should be installed by default on all systems. Under Windows, libgit2 uses the native Windows API
for threading.

Vicent Marti committed
49
The libgit2 library is built using CMake 2.6+ (<http://www.cmake.org>) on all platforms.
Scott Chacon committed
50

Vicent Marti committed
51
On most systems you can build the library using the following commands
Scott Chacon committed
52

Vicent Marti committed
53 54 55
	$ mkdir build && cd build
	$ cmake ..
	$ cmake --build .
56

Vicent Marti committed
57 58 59
Alternatively you can point the CMake GUI tool to the CMakeLists.txt file and generate platform specific build project or IDE workspace.

To install the library you can specify the install prefix by setting:
Scott Chacon committed
60

Vicent Marti committed
61 62
	$ cmake .. -DCMAKE_INSTALL_PREFIX=/install/prefix
	$ cmake --build . --target install
Scott Chacon committed
63

Vicent Marti committed
64
For more advanced use or questions about CMake please read <http://www.cmake.org/Wiki/CMake_FAQ>.
65

Vicent Marti committed
66 67
The following CMake variables are declared:

68
- `BIN_INSTALL_DIR`: Where to install binaries to.
69
- `LIB_INSTALL_DIR`: Where to install libraries to.
70
- `INCLUDE_INSTALL_DIR`: Where to install headers to.
71
- `BUILD_SHARED_LIBS`: Build libgit2 as a Shared Library (defaults to ON)
Keith Dahlby committed
72
- `BUILD_CLAR`: Build [Clar](https://github.com/vmg/clar)-based test suite (defaults to ON)
Vicent Marti committed
73
- `THREADSAFE`: Build libgit2 with threading support (defaults to OFF)
74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104
- `STDCALL`: Build libgit2 as `stdcall`. Turn off for `cdecl` (Windows; defaults to ON)

Compiler and linker options
---------------------------

CMake lets you specify a few variables to control the behavior of the
compiler and linker. These flags are rarely used but can be useful for
64-bit to 32-bit cross-compilation.

- `CMAKE_C_FLAGS`: Set your own compiler flags
- `CMAKE_FIND_ROOT_PATH`: Override the search path for libraries
- `ZLIB_LIBRARY`, `OPENSSL_SSL_LIBRARY` AND `OPENSSL_CRYPTO_LIBRARY`:
Tell CMake where to find those specific libraries

MacOS X
-------

If you want to build a universal binary for Mac OS X, CMake sets it
all up for you if you use `-DCMAKE_OSX_ARCHITECTURES="i386;x86_64"`
when configuring.

Windows
-------

You need to run the CMake commands from the Visual Studio command
prompt, not the regular or Windows SDK one. Select the right generator
for your version with the `-G "Visual Studio X" option.

See [the wiki]
(https://github.com/libgit2/libgit2/wiki/Building-libgit2-on-Windows)
for more detailed instructions.
105

Vicent Marti committed
106 107
Language Bindings
==================================
Scott Chacon committed
108

Vicent Marti committed
109
Here are the bindings to libgit2 that are currently available:
Scott Chacon committed
110

111 112
* C++
    * libqgit2, Qt bindings <https://projects.kde.org/projects/playground/libs/libqgit2/>
113 114
* Chicken Scheme
    * chicken-git <https://wiki.call-cc.org/egg/git>
115 116
* D
    * dlibgit <https://github.com/AndrejMitrovic/dlibgit>
117 118 119 120 121 122 123
* Delphi
    * GitForDelphi <https://github.com/libgit2/GitForDelphi>
* Erlang
    * Geef <https://github.com/schacon/geef>
* Go
    * go-git <https://github.com/str1ngs/go-git>
* GObject
124
    * libgit2-glib <https://live.gnome.org/Libgit2-glib>
125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150
* Haskell
    * hgit2 <https://github.com/norm2782/hgit2>
* Lua
    * luagit2 <https://github.com/libgit2/luagit2>
* .NET
    * libgit2net, low level bindings <https://github.com/txdv/libgit2net>
    * libgit2sharp <https://github.com/libgit2/libgit2sharp>
* Node.js
    * node-gitteh <https://github.com/libgit2/node-gitteh>
    * nodegit <https://github.com/tbranyen/nodegit>
* Objective-C
    * objective-git <https://github.com/libgit2/objective-git>
* OCaml
    * libgit2-ocaml <https://github.com/burdges/libgit2-ocaml>
* Parrot Virtual Machine
    * parrot-libgit2 <https://github.com/letolabs/parrot-libgit2>
* Perl
    * git-xs-pm <https://github.com/ingydotnet/git-xs-pm>
* PHP
    * php-git <https://github.com/libgit2/php-git>
* Python
    * pygit2 <https://github.com/libgit2/pygit2>
* Ruby
    * Rugged <https://github.com/libgit2/rugged>
* Vala
    * libgit2.vapi <https://github.com/apmasell/vapis/blob/master/libgit2.vapi>
Scott Chacon committed
151 152 153 154

If you start another language binding to libgit2, please let us know so
we can add it to the list.

155
How Can I Contribute?
156 157 158
==================================

Fork libgit2/libgit2 on GitHub, add your improvement, push it to a branch
159
in your fork named for the topic, send a pull request. If you change the
160
API or make other large changes, make a note of it in docs/rel-notes/ in a
161
file named after the next release.
162 163 164 165 166 167 168

You can also file bugs or feature requests under the libgit2 project on
GitHub, or join us on the mailing list by sending an email to:

libgit2@librelist.com


169
License
Scott Chacon committed
170
==================================
Vicent Marti committed
171
libgit2 is under GPL2 **with linking exemption**. This means you
Scott Chacon committed
172 173 174 175 176
can link to the library with any program, commercial, open source or
other.  However, you cannot modify libgit2 and distribute it without
supplying the source.

See the COPYING file for the full license text.