Skip to content

Commit 4dacd1c

Browse files
committed
Minor Readme refinements
1 parent 8f14a3d commit 4dacd1c

1 file changed

Lines changed: 28 additions & 12 deletions

File tree

README.md

Lines changed: 28 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,28 @@
1-
Native Binaries NuGet Package for LibGit2Sharp
2-
==============================================
1+
# LibGit2Sharp.NativeBinaries
32

4-
[Libgit2Sharp](https://github.com/libgit2/libgit2sharp) is a managed
5-
wrapper around [libgit2](https://github.com/libgit2/libgit2), and as
6-
such requires compilation of libgit2 for your platform. LibGit2Sharp
7-
makes this easy by distributing NuGet packages that include precompiled
8-
versions of these native binaries.
3+
**[Libgit2Sharp][lg2s]** is a managed wrapper around **[libgit2][lg2]**, and as
4+
such requires compilation of libgit2 for your platform.
5+
6+
LibGit2Sharp makes this easy by distributing, and leveraging as a dependency,
7+
the **[LibGit2Sharp.NativeBinaries][lg2s-nb]** NuGet package.
8+
9+
This package contains the compiled versions of the libgit2 native library for
10+
the following platforms:
11+
12+
- Windows (x86/amd64)
13+
- Mac OS X (x86/amd64)
14+
- Linux (amd64)
15+
16+
**Note:** Due to the large number of distributions, the Linux support is
17+
currently *experimental*. Would you encounter any issue with it, please open an
18+
**[issue][tracker]**.
19+
20+
[lg2s-nb]: https://www.nuget.org/packages/LibGit2Sharp.NativeBinaries
21+
[lg2]: https://libgit2.github.com/
22+
[lg2s]: http://libgit2sharp.com/
23+
[tracker]: https://github.com/libgit2/libgit2sharp.nativebinaries/issues
24+
25+
## How to build your own native binaries
926

1027
If you need to build your own native binaries for some reason, you can
1128
do so easily with the scripts in this repository:
@@ -63,8 +80,8 @@ do so easily with the scripts in this repository:
6380
any mixups with the official packages, but may also require you to
6481
opt-in to prerelease packages in your NuGet package manager.
6582

66-
Specifying custom DLL names
67-
---------------------------
83+
## Specifying custom DLL names
84+
6885
If you want to redistribute a LibGit2Sharp that uses a custom libgit2,
6986
you may want to change the name of the libgit2 shared library file to
7087
disambiguate it from other installations. This may be useful if you
@@ -84,8 +101,8 @@ Then build the NuGet package as described above, making sure to provide
84101
a helpful suffix to ensure that your NuGet package will not be confused
85102
with the official packages.
86103

87-
Notes on Visual Studio
88-
----------------------
104+
### Notes on Visual Studio
105+
89106
Visual Studio is required to build the native binaries, however you
90107
do not need to install a *paid* version of Visual Studio. libgit2
91108
can be compiled using [Visual Studio Community](https://www.visualstudio.com/en-us/products/visual-studio-community-vs),
@@ -101,4 +118,3 @@ product, but its actual version number is "12.0".) A handy guide:
101118
| Visual Studio 2012 | 11
102119
| Visual Studio 2013 | 12
103120
| Visual Studio 2015 | 14
104-

0 commit comments

Comments
 (0)