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

4
[![Build Status](https://secure.travis-ci.org/libgit2/libgit2.png?branch=development)](http://travis-ci.org/libgit2/libgit2)
5
[![Coverity Scan Build Status](https://scan.coverity.com/projects/639/badge.svg)](https://scan.coverity.com/projects/639)
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.
Scott Chacon committed
10

11 12 13 14 15
`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.
Additionally, the example code has been released to the public domain (see the
[separate license](examples/COPYING) for more information).
16

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

Scott Chacon committed
29 30

What It Can Do
31
==============
Scott Chacon committed
32

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

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

50 51 52 53 54 55 56 57 58 59 60
Optional dependencies
=====================

While the library provides git functionality without the need for
dependencies, it can make use of a few libraries to add to it:

- pthreads (non-Windows) to enable threadsafe access as well as multi-threaded pack generation
- OpenSSL (non-Windows) to talk over HTTPS and provide the SHA-1 functions
- LibSSH2 to enable the ssh transport
- iconv (OSX) to handle the HFS+ path encoding peculiarities

Vicent Marti committed
61 62
Building libgit2 - Using CMake
==============================
Peter Drahoš committed
63

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

69
The `libgit2` library is built using [CMake](<http://www.cmake.org>) (version 2.6 or newer) on all platforms.
Scott Chacon committed
70

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

Vicent Marti committed
73 74 75
	$ mkdir build && cd build
	$ cmake ..
	$ cmake --build .
76

Vicent Marti committed
77 78 79
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
80

Vicent Marti committed
81 82
	$ cmake .. -DCMAKE_INSTALL_PREFIX=/install/prefix
	$ cmake --build . --target install
Scott Chacon committed
83

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

Vicent Marti committed
86 87
The following CMake variables are declared:

88
- `BIN_INSTALL_DIR`: Where to install binaries to.
89
- `LIB_INSTALL_DIR`: Where to install libraries to.
90
- `INCLUDE_INSTALL_DIR`: Where to install headers to.
91
- `BUILD_SHARED_LIBS`: Build libgit2 as a Shared Library (defaults to ON)
Keith Dahlby committed
92
- `BUILD_CLAR`: Build [Clar](https://github.com/vmg/clar)-based test suite (defaults to ON)
Vicent Marti committed
93
- `THREADSAFE`: Build libgit2 with threading support (defaults to OFF)
94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124
- `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.
125

126 127 128 129
Android
-------

Extract toolchain from NDK using, `make-standalone-toolchain.sh` script.
Nicolas Kaiser committed
130 131
Optionally, crosscompile and install OpenSSL inside of it. Then create CMake
toolchain file that configures paths to your crosscompiler (substitute `{PATH}`
132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147
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
148 149
Language Bindings
==================================
Scott Chacon committed
150

Vicent Marti committed
151
Here are the bindings to libgit2 that are currently available:
Scott Chacon committed
152

153 154
* C++
    * libqgit2, Qt bindings <https://projects.kde.org/projects/playground/libs/libqgit2/>
155 156
* Chicken Scheme
    * chicken-git <https://wiki.call-cc.org/egg/git>
157 158
* D
    * dlibgit <https://github.com/AndrejMitrovic/dlibgit>
159 160 161
* Delphi
    * GitForDelphi <https://github.com/libgit2/GitForDelphi>
* Erlang
162
    * Geef <https://github.com/carlosmn/geef>
163
* Go
164
    * git2go <https://github.com/libgit2/git2go>
165
* GObject
166
    * libgit2-glib <https://live.gnome.org/Libgit2-glib>
167
* Haskell
168
    * hgit2 <https://github.com/fpco/gitlib>
169 170
* Java
    * Jagged <https://github.com/ethomson/jagged>
171 172
* Julia
    * LibGit2.jl <https://github.com/jakebolewski/LibGit2.jl>
173 174 175 176 177 178 179 180 181 182 183 184 185 186
* Lua
    * luagit2 <https://github.com/libgit2/luagit2>
* .NET
    * 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
187
    * Git-Raw <https://github.com/jacquesg/p5-Git-Raw>
188 189
* PHP
    * php-git <https://github.com/libgit2/php-git>
190 191
* PowerShell
    * GitPowerShell <https://github.com/ethomson/gitpowershell>
192 193
* Python
    * pygit2 <https://github.com/libgit2/pygit2>
194 195
* R
    * git2r <https://github.com/ropensci/git2r>
196 197 198 199
* Ruby
    * Rugged <https://github.com/libgit2/rugged>
* Vala
    * libgit2.vapi <https://github.com/apmasell/vapis/blob/master/libgit2.vapi>
Scott Chacon committed
200 201 202 203

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

204
How Can I Contribute?
205 206
==================================

207 208 209
Check the [contribution guidelines](CONTRIBUTING.md) to understand our
workflow, the libgit2 [coding conventions](CONVENTIONS.md), and out list of
[good starting projects](PROJECTS.md).
210

211
License
Scott Chacon committed
212
==================================
213 214 215 216

`libgit2` is under GPL2 **with linking exemption**. This means you can link to
and use the library from any program, proprietary or open source; paid or
gratis.  However, you cannot modify libgit2 and distribute it without
Scott Chacon committed
217 218
supplying the source.

219
See the [COPYING file](COPYING) for the full license text.