Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 100 lines (66 sloc) 4.56 kB
f8bc191 @nulltoken Update readme.md
nulltoken authored
1 # LibGit2Sharp
0bee099 @tclem Squash up commits on devel branch
tclem authored
2
525296c @richlander Correct ".NET" usage
richlander authored
3 **LibGit2Sharp brings all the might and speed of [libgit2][libgit2], a native Git implementation, to the managed world of .NET and Mono.**
cb893b5 @nulltoken Switch README content to reference-style linking
nulltoken authored
4
2f1c52f @nulltoken Update README.md to reflect the new Windows CI hoster
nulltoken authored
5 [libgit2]: http://libgit2.github.com/
0bee099 @tclem Squash up commits on devel branch
tclem authored
6
a2682ed @nulltoken Release LibGit2Sharp v0.20
nulltoken authored
7 ## Prerequisites
8
525296c @richlander Correct ".NET" usage
richlander authored
9 - **Windows:** .NET 4.0+
9470841 @ZhangHang Fix typo
ZhangHang authored
10 - **Linux/Mac OS X:** Mono 3.6+
a2682ed @nulltoken Release LibGit2Sharp v0.20
nulltoken authored
11
9fd45dd @nulltoken Release LibGit2Sharp v0.6.1
nulltoken authored
12 ## Online resources
7047701 @nulltoken Prepare NuGet packaging
nulltoken authored
13
2f1c52f @nulltoken Update README.md to reflect the new Windows CI hoster
nulltoken authored
14 - [NuGet package][nuget] (Requires NuGet 2.7+)
15 - [Source code][source]
cb893b5 @nulltoken Switch README content to reference-style linking
nulltoken authored
16
2f1c52f @nulltoken Update README.md to reflect the new Windows CI hoster
nulltoken authored
17 [nuget]: http://nuget.org/List/Packages/LibGit2Sharp
18 [source]: https://github.com/libgit2/libgit2sharp/
79ee568 @nulltoken Release LibGit2Sharp v0.9.0
nulltoken authored
19
20 ## Troubleshooting and support
21
2f1c52f @nulltoken Update README.md to reflect the new Windows CI hoster
nulltoken authored
22 - Usage or programming related question? Post it on [StackOverflow][so] using the tag *libgit2sharp*
23 - Found a bug or missing a feature? Feed the [issue tracker][tracker]
24 - Announcements and related miscellanea through Twitter ([@libgit2sharp][twitter])
cb893b5 @nulltoken Switch README content to reference-style linking
nulltoken authored
25
2f1c52f @nulltoken Update README.md to reflect the new Windows CI hoster
nulltoken authored
26 [so]: http://stackoverflow.com/questions/tagged/libgit2sharp
27 [tracker]: https://github.com/libgit2/libgit2sharp/issues
28 [twitter]: http://twitter.com/libgit2sharp
7047701 @nulltoken Prepare NuGet packaging
nulltoken authored
29
180ffa4 @somewhatabstract Added coveralls.io status and supporting text
somewhatabstract authored
30 ## Current project status
611e412 @nulltoken Link to Coverity from the README
nulltoken authored
31
2f1c52f @nulltoken Update README.md to reflect the new Windows CI hoster
nulltoken authored
32 The CI builds are generously hosted and run on the [Travis][travis] and [AppVeyor][appveyor] infrastructures.
33
9470841 @ZhangHang Fix typo
ZhangHang authored
34 | | Windows (x86/amd64) | Linux/Mac OS X |
2f1c52f @nulltoken Update README.md to reflect the new Windows CI hoster
nulltoken authored
35 | :------ | :------: | :------: |
36 | **master** | [![master win][master-win-badge]][master-win] | [![master nix][master-nix-badge]][master-nix] |
37 | **vNext** | [![vNext win][vNext-win-badge]][vNext-win] | [![vNext nix][vNext-nix-badge]][vNext-nix] |
38
180ffa4 @somewhatabstract Added coveralls.io status and supporting text
somewhatabstract authored
39 The security-oriented static code analysis is kindly run through the [Coverity][coverity] service. Code coverage is kindly run through [Coveralls.io][coveralls].
611e412 @nulltoken Link to Coverity from the README
nulltoken authored
40
180ffa4 @somewhatabstract Added coveralls.io status and supporting text
somewhatabstract authored
41 | | Static Analysis | Code Coverage |
42 |-------|-----------------|---------------|
43 | **vNext** | [![coverity][coverity-badge]][coverity-project] | [![coveralls][coveralls-badge]][coveralls-project] |
611e412 @nulltoken Link to Coverity from the README
nulltoken authored
44
2f1c52f @nulltoken Update README.md to reflect the new Windows CI hoster
nulltoken authored
45
611e412 @nulltoken Link to Coverity from the README
nulltoken authored
46 [travis]: https://travis-ci.org/
2f1c52f @nulltoken Update README.md to reflect the new Windows CI hoster
nulltoken authored
47 [appveyor]: http://appveyor.com/
611e412 @nulltoken Link to Coverity from the README
nulltoken authored
48 [coverity]: https://scan.coverity.com/
180ffa4 @somewhatabstract Added coveralls.io status and supporting text
somewhatabstract authored
49 [coveralls]: https://coveralls.io/
611e412 @nulltoken Link to Coverity from the README
nulltoken authored
50
2f1c52f @nulltoken Update README.md to reflect the new Windows CI hoster
nulltoken authored
51 [master-win-badge]: https://ci.appveyor.com/api/projects/status/8qxcoqdo9kp7x2w9/branch/master?svg=true
52 [master-win]: https://ci.appveyor.com/project/libgit2/libgit2sharp/branch/master
53 [master-nix-badge]: https://travis-ci.org/libgit2/libgit2sharp.svg?branch=master
54 [master-nix]: https://travis-ci.org/libgit2/libgit2sharp/branches
55 [vNext-win-badge]: https://ci.appveyor.com/api/projects/status/8qxcoqdo9kp7x2w9/branch/vNext?svg=true
56 [vNext-win]: https://ci.appveyor.com/project/libgit2/libgit2sharp/branch/vNext
57 [vNext-nix-badge]: https://travis-ci.org/libgit2/libgit2sharp.svg?branch=vNext
58 [vNext-nix]: https://travis-ci.org/libgit2/libgit2sharp/branches
b67ec30 @nulltoken Add a build status section to the README file
nulltoken authored
59
611e412 @nulltoken Link to Coverity from the README
nulltoken authored
60 [coverity-project]: https://scan.coverity.com/projects/2088
61 [coverity-badge]: https://scan.coverity.com/projects/2088/badge.svg
62
180ffa4 @somewhatabstract Added coveralls.io status and supporting text
somewhatabstract authored
63 [coveralls-project]: https://coveralls.io/r/libgit2/libgit2sharp?branch=vNext
64 [coveralls-badge]: https://coveralls.io/repos/libgit2/libgit2sharp/badge.svg?branch=vNext
65
c56870e @nulltoken Move the backlog to the root of the repository
nulltoken authored
66 ## Quick contributing guide
0bee099 @tclem Squash up commits on devel branch
tclem authored
67
f8bc191 @nulltoken Update readme.md
nulltoken authored
68 - Fork and clone locally
69 - Create a topic specific branch. Add some nice feature. Do not forget the tests ;-)
70 - Send a Pull Request to spread the fun!
0bee099 @tclem Squash up commits on devel branch
tclem authored
71
2f1c52f @nulltoken Update README.md to reflect the new Windows CI hoster
nulltoken authored
72 More thorough information available in the [wiki][wiki].
cb893b5 @nulltoken Switch README content to reference-style linking
nulltoken authored
73
2f1c52f @nulltoken Update README.md to reflect the new Windows CI hoster
nulltoken authored
74 [wiki]: https://github.com/libgit2/libgit2sharp/wiki
c56870e @nulltoken Move the backlog to the root of the repository
nulltoken authored
75
b5223d5 @whoisj Enable custom unit test location with standard location fallback
whoisj authored
76 ## Optimizing unit testing
77 LibGit2Sharp strives to have comprehensive and robust unit test suite to insure the quality of the software and to assist new contributors and users who can use the tests as sample to jump start development. There are over one-thousand unit-tests for LibGit2Sharp, this number will only grow as functionality is added.
78
79 You can do a few things to optimize running unit-tests on Windows:
80
81 1. Set the `LibGit2TestPath` environment variable to a path in your development environment.
82 * If the unit-test framework cannot find the specified folder at runtime, it will fall back to the default location.
83 2. Configure your anti-virus software to ignore the `LibGit2TestPath` path.
84 3. Install a RAM disk like [IMDisk](http://www.ltr-data.se/opencode.html/#ImDisk) and set `LibGit2TestPath` to use it.
85 * Use `imdisk.exe -a -s 256M -m X: -p "/fs:fat /q /v:ramdisk /y"` to create a RAM disk. This command requires elevated privileges and can be placed into a scheduled task or run manually before you begin unit-testing.
86
f8bc191 @nulltoken Update readme.md
nulltoken authored
87 ## Authors
0bee099 @tclem Squash up commits on devel branch
tclem authored
88
2f1c52f @nulltoken Update README.md to reflect the new Windows CI hoster
nulltoken authored
89 - **Code:** The LibGit2Sharp [contributors][committers]
90 - **Logo:** [Jason "blackant" Long][blackant]
cb893b5 @nulltoken Switch README content to reference-style linking
nulltoken authored
91
2f1c52f @nulltoken Update README.md to reflect the new Windows CI hoster
nulltoken authored
92 [committers]: https://github.com/libgit2/libgit2sharp/contributors
93 [blackant]: https://github.com/jasonlong
0bee099 @tclem Squash up commits on devel branch
tclem authored
94
f8bc191 @nulltoken Update readme.md
nulltoken authored
95 ## License
0bee099 @tclem Squash up commits on devel branch
tclem authored
96
2f1c52f @nulltoken Update README.md to reflect the new Windows CI hoster
nulltoken authored
97 The MIT license (Refer to the [LICENSE.md][license] file)
cb893b5 @nulltoken Switch README content to reference-style linking
nulltoken authored
98
2f1c52f @nulltoken Update README.md to reflect the new Windows CI hoster
nulltoken authored
99 [license]: https://github.com/libgit2/libgit2sharp/blob/master/LICENSE.md
Something went wrong with that request. Please try again.