Skip to content

Commit 81c98af

Browse files
authored
Merge pull request libgit2#5772 from libgit2/ethomson/readme
README: instructions for using libgit2 without compiling
2 parents 8462f7f + 4ac1263 commit 81c98af

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ Additionally, the example code has been released to the public domain (see the
3333
Table of Contents
3434
=================
3535

36+
* [Using libgit2](#using-libgit2)
3637
* [Quick Start](#quick-start)
3738
* [Getting Help](#getting-help)
3839
* [What It Can Do](#what-it-can-do)
@@ -52,6 +53,28 @@ Table of Contents
5253
* [How Can I Contribute?](#how-can-i-contribute)
5354
* [License](#license)
5455

56+
Using libgit2
57+
=============
58+
59+
Most of these instructions assume that you're writing an application
60+
in C and want to use libgit2 directly. If you're _not_ using C,
61+
and you're writing in a different language or platform like .NET,
62+
Node.js, or Ruby, then there is probably a
63+
"[language binding](#language-bindings)" that you can use to take care
64+
of the messy tasks of calling into native code.
65+
66+
But if you _do_ want to use libgit2 directly - because you're building
67+
an application in C - then you may be able use an existing binary.
68+
There are packages for the
69+
[vcpkg](https://github.com/Microsoft/vcpkg) and
70+
[conan](https://conan.io/center/libgit2)
71+
package managers. And libgit2 is available in
72+
[Homebrew](https://formulae.brew.sh/formula/libgit2) and most Linux
73+
distributions.
74+
75+
However, these versions _may_ be outdated and we recommend using the
76+
latest version if possible. Thankfully libgit2 is not hard to compile.
77+
5578
Quick Start
5679
===========
5780

0 commit comments

Comments
 (0)