README.md 7.29 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)

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

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

14
* Website: [libgit2.github.com](http://libgit2.github.com)
15
* StackOverflow Tag: [libgit2](http://stackoverflow.com/questions/tagged/libgit2)
16
* Issues: [GitHub Issues](https://github.com/libgit2/libgit2/issues) (Right here!)
17
* API documentation: <http://libgit2.github.com/libgit2>
18
* IRC: [#libgit2](irc://irc.freenode.net/libgit2) on irc.freenode.net.
19 20
* Mailing list: The libgit2 mailing list was
    traditionally hosted in Librelist but has been deprecated. We encourage you to 
21
    [use StackOverflow](http://stackoverflow.com/questions/tagged/libgit2) instead for any questions regarding
Edward Thomson committed
22
    the library, or [open an issue](https://github.com/libgit2/libgit2/issues) 
23
    on GitHub for bug reports.  The mailing list archives are still available at 
24 25
    <http://librelist.com/browser/libgit2/>.

Scott Chacon committed
26 27

What It Can Do
28
==============
Scott Chacon committed
29

30
`libgit2` is already very usable and is being used in production for many applications including the GitHub.com site, in Plastic SCM 
31
and also powering Microsoft's Visual Studio tools for Git.  The library provides:
32

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

Vicent Marti committed
46 47
Building libgit2 - Using CMake
==============================
Peter Drahoš committed
48

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

54
The `libgit2` library is built using `CMake 2.6+` (<http://www.cmake.org>) on all platforms.
Scott Chacon committed
55

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

Vicent Marti committed
58 59 60
	$ mkdir build && cd build
	$ cmake ..
	$ cmake --build .
61

Vicent Marti committed
62 63 64
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
65

Vicent Marti committed
66 67
	$ cmake .. -DCMAKE_INSTALL_PREFIX=/install/prefix
	$ cmake --build . --target install
Scott Chacon committed
68

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

Vicent Marti committed
71 72
The following CMake variables are declared:

73
- `BIN_INSTALL_DIR`: Where to install binaries to.
74
- `LIB_INSTALL_DIR`: Where to install libraries to.
75
- `INCLUDE_INSTALL_DIR`: Where to install headers to.
76
- `BUILD_SHARED_LIBS`: Build libgit2 as a Shared Library (defaults to ON)
Keith Dahlby committed
77
- `BUILD_CLAR`: Build [Clar](https://github.com/vmg/clar)-based test suite (defaults to ON)
Vicent Marti committed
78
- `THREADSAFE`: Build libgit2 with threading support (defaults to OFF)
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 105 106 107 108 109
- `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.
110

111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132
Android
-------

Extract toolchain from NDK using, `make-standalone-toolchain.sh` script.
Optionaly, crosscompile and install OpenSSL inside of it. Then create CMake
toolchain file that configures paths to your crosscompiler (substitude `{PATH}`
with full path to the toolchain):

	SET(CMAKE_SYSTEM_NAME Linux)
	SET(CMAKE_SYSTEM_VERSION Android)
	
	SET(CMAKE_C_COMPILER   {PATH}/bin/arm-linux-androideabi-gcc)
	SET(CMAKE_CXX_COMPILER {PATH}/bin/arm-linux-androideabi-g++)
	SET(CMAKE_FIND_ROOT_PATH {PATH}/sysroot/)
	
	SET(CMAKE_FIND_ROOT_PATH_MODE_PROGRAM NEVER)
	SET(CMAKE_FIND_ROOT_PATH_MODE_LIBRARY ONLY)
	SET(CMAKE_FIND_ROOT_PATH_MODE_INCLUDE ONLY)

Add `-DCMAKE_TOOLCHAIN_FILE={pathToToolchainFile} -DANDROID=1` to cmake command
when configuring.

Vicent Marti committed
133 134
Language Bindings
==================================
Scott Chacon committed
135

Vicent Marti committed
136
Here are the bindings to libgit2 that are currently available:
Scott Chacon committed
137

138 139
* C++
    * libqgit2, Qt bindings <https://projects.kde.org/projects/playground/libs/libqgit2/>
140 141
* Chicken Scheme
    * chicken-git <https://wiki.call-cc.org/egg/git>
142 143
* D
    * dlibgit <https://github.com/AndrejMitrovic/dlibgit>
144 145 146
* Delphi
    * GitForDelphi <https://github.com/libgit2/GitForDelphi>
* Erlang
147
    * Geef <https://github.com/carlosmn/geef>
148
* Go
149
    * git2go <https://github.com/libgit2/git2go>
150
* GObject
151
    * libgit2-glib <https://live.gnome.org/Libgit2-glib>
152
* Haskell
153
    * hgit2 <https://github.com/fpco/gitlib>
154 155 156 157
* Lua
    * luagit2 <https://github.com/libgit2/luagit2>
* .NET
    * libgit2sharp <https://github.com/libgit2/libgit2sharp>
158
    * libgit2net, low level bindings superceeded by libgit2sharp <https://github.com/txdv/libgit2net>
159 160 161 162 163 164 165 166 167 168
* 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
169
    * Git-Raw <https://github.com/ghedo/p5-Git-Raw>
170 171 172 173 174 175 176 177
* 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
178 179 180 181

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

182
How Can I Contribute?
183 184
==================================

Ben Straub committed
185
Check the [contribution guidelines](CONTRIBUTING.md).
186 187


188
License
Scott Chacon committed
189
==================================
190 191 192
`libgit2` is under GPL2 **with linking exemption**. This means you
can link to the library with any program, proprietary or open source; paid
or gratis.  However, you cannot modify libgit2 and distribute it without
Scott Chacon committed
193 194 195
supplying the source.

See the COPYING file for the full license text.