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

4
[![Travis Build Status](https://secure.travis-ci.org/libgit2/libgit2.png?branch=master)](http://travis-ci.org/libgit2/libgit2)
5
[![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/gnjsdi9r48cfoveg/branch/master?svg=true)](https://ci.appveyor.com/project/nulltoken/libgit2/branch/master)
6
[![Coverity Scan Build Status](https://scan.coverity.com/projects/639/badge.svg)](https://scan.coverity.com/projects/639)
7

8 9 10
`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
11

12 13 14 15 16
`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).
17

18
* Website: [libgit2.github.com](http://libgit2.github.com)
19
* StackOverflow Tag: [libgit2](http://stackoverflow.com/questions/tagged/libgit2)
20
* Issues: [GitHub Issues](https://github.com/libgit2/libgit2/issues) (Right here!)
21
* API documentation: <http://libgit2.github.com/libgit2>
22
* IRC: [#libgit2](irc://irc.freenode.net/libgit2) on irc.freenode.net.
23
* Mailing list: The libgit2 mailing list was
24
    traditionally hosted in Librelist but has been deprecated. We encourage you to
25
    [use StackOverflow](http://stackoverflow.com/questions/tagged/libgit2) instead for any questions regarding
26 27
    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
28 29
    <http://librelist.com/browser/libgit2/>.

Scott Chacon committed
30 31

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

34 35 36
`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:
37

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

51 52 53 54 55 56 57 58
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
Linquize committed
59
- LibSSH2 to enable the SSH transport
60 61
- iconv (OSX) to handle the HFS+ path encoding peculiarities

62 63 64 65 66
Threading
=========

See [THREADING](THREADING.md) for information

Vicent Marti committed
67 68
Building libgit2 - Using CMake
==============================
Peter Drahoš committed
69

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

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

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

Vicent Marti committed
79 80 81
	$ mkdir build && cd build
	$ cmake ..
	$ cmake --build .
82

Vicent Marti committed
83 84 85
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
86

Vicent Marti committed
87 88
	$ cmake .. -DCMAKE_INSTALL_PREFIX=/install/prefix
	$ cmake --build . --target install
Scott Chacon committed
89

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

Vicent Marti committed
92 93
The following CMake variables are declared:

94
- `BIN_INSTALL_DIR`: Where to install binaries to.
95
- `LIB_INSTALL_DIR`: Where to install libraries to.
96
- `INCLUDE_INSTALL_DIR`: Where to install headers to.
97
- `BUILD_SHARED_LIBS`: Build libgit2 as a Shared Library (defaults to ON)
Keith Dahlby committed
98
- `BUILD_CLAR`: Build [Clar](https://github.com/vmg/clar)-based test suite (defaults to ON)
99
- `THREADSAFE`: Build libgit2 with threading support (defaults to ON)
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 125 126 127
- `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.

Brendan Forster committed
128
See [the website](https://libgit2.github.com/docs/guides/build-and-link)
129
for more detailed instructions.
130

131 132 133 134
Android
-------

Extract toolchain from NDK using, `make-standalone-toolchain.sh` script.
Nicolas Kaiser committed
135 136
Optionally, crosscompile and install OpenSSL inside of it. Then create CMake
toolchain file that configures paths to your crosscompiler (substitute `{PATH}`
137 138 139 140
with full path to the toolchain):

	SET(CMAKE_SYSTEM_NAME Linux)
	SET(CMAKE_SYSTEM_VERSION Android)
nulltoken committed
141

142 143 144
	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/)
nulltoken committed
145

146 147 148 149 150 151 152
	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
153 154
Language Bindings
==================================
Scott Chacon committed
155

Vicent Marti committed
156
Here are the bindings to libgit2 that are currently available:
Scott Chacon committed
157

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

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

211
How Can I Contribute?
212 213
==================================

214 215 216
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).
217

218
License
Scott Chacon committed
219
==================================
220

SeijiIto committed
221
`libgit2` is under GPL2 **with linking exception**. This means you can link to
222 223
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
224 225
supplying the source.

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