Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
78 changes: 38 additions & 40 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# LibGit2Sharp

**LibGit2Sharp brings all the might and speed of [libgit2][0], a native Git implementation, to the managed world of .Net and Mono.**
**LibGit2Sharp brings all the might and speed of [libgit2][libgit2], a native Git implementation, to the managed world of .Net and Mono.**

[0]: http://libgit2.github.com/
[libgit2]: http://libgit2.github.com/

## Prerequisites

Expand All @@ -11,64 +11,62 @@

## Online resources

- [NuGet package][1] (Requires NuGet 2.7+)
- [Source code][2]
- [Continuous integration][3]
- [NuGet package][nuget] (Requires NuGet 2.7+)
- [Source code][source]

[1]: http://nuget.org/List/Packages/LibGit2Sharp
[2]: https://github.com/libgit2/libgit2sharp/
[3]: http://teamcity.codebetter.com/project.html?projectId=LibGit2Sharp&guest=1
[nuget]: http://nuget.org/List/Packages/LibGit2Sharp
[source]: https://github.com/libgit2/libgit2sharp/

## Troubleshooting and support

- Usage or programming related question? Post it on [StackOverflow][4] using the tag *libgit2sharp*
- Found a bug or missing a feature? Feed the [issue tracker][5]
- Announcements and related miscellanea through Twitter ([@libgit2sharp][6])
- Usage or programming related question? Post it on [StackOverflow][so] using the tag *libgit2sharp*
- Found a bug or missing a feature? Feed the [issue tracker][tracker]
- Announcements and related miscellanea through Twitter ([@libgit2sharp][twitter])

[4]: http://stackoverflow.com/questions/tagged/libgit2sharp
[5]: https://github.com/libgit2/libgit2sharp/issues
[6]: http://twitter.com/libgit2sharp
[so]: http://stackoverflow.com/questions/tagged/libgit2sharp
[tracker]: https://github.com/libgit2/libgit2sharp/issues
[twitter]: http://twitter.com/libgit2sharp

## Current project build status
The [build][3] is generously hosted and run on the [CodeBetter TeamCity][7] infrastructure.

| | Status of last build |
| :------ | :------: |
| **master** | [![master][8]][9] |
| **vNext (Win x86)** | [![vNext x86][10]][11] |
| **vNext (Win amd64)** | [![vNext amd64][12]][13] |
| **vNext (Mono)** | [![vNext Mono][14]][15] |

[7]: http://codebetter.com/codebetter-ci/
[8]: http://teamcity.codebetter.com/app/rest/builds/buildType:(id:bt398)/statusIcon
[9]: http://teamcity.codebetter.com/viewType.html?buildTypeId=bt398&guest=1
[10]: http://teamcity.codebetter.com/app/rest/builds/buildType:(id:bt651)/statusIcon
[11]: http://teamcity.codebetter.com/viewType.html?buildTypeId=bt651&guest=1
[12]: http://teamcity.codebetter.com/app/rest/builds/buildType:(id:bt652)/statusIcon
[13]: http://teamcity.codebetter.com/viewType.html?buildTypeId=bt652&guest=1
[14]: http://teamcity.codebetter.com/app/rest/builds/buildType:(id:bt656)/statusIcon
[15]: http://teamcity.codebetter.com/viewType.html?buildTypeId=bt656&guest=1
The CI builds are generously hosted and run on the [Travis][travis] and [AppVeyor][appveyor] infrastructures.

| | Windows (x86/amd64) | Linux/MacOsX |
| :------ | :------: | :------: |
| **master** | [![master win][master-win-badge]][master-win] | [![master nix][master-nix-badge]][master-nix] |
| **vNext** | [![vNext win][vNext-win-badge]][vNext-win] | [![vNext nix][vNext-nix-badge]][vNext-nix] |


[travis]: http://travis-ci.org/
[appveyor]: http://appveyor.com/
[master-win-badge]: https://ci.appveyor.com/api/projects/status/8qxcoqdo9kp7x2w9/branch/master?svg=true
[master-win]: https://ci.appveyor.com/project/libgit2/libgit2sharp/branch/master
[master-nix-badge]: https://travis-ci.org/libgit2/libgit2sharp.svg?branch=master
[master-nix]: https://travis-ci.org/libgit2/libgit2sharp/branches
[vNext-win-badge]: https://ci.appveyor.com/api/projects/status/8qxcoqdo9kp7x2w9/branch/vNext?svg=true
[vNext-win]: https://ci.appveyor.com/project/libgit2/libgit2sharp/branch/vNext
[vNext-nix-badge]: https://travis-ci.org/libgit2/libgit2sharp.svg?branch=vNext
[vNext-nix]: https://travis-ci.org/libgit2/libgit2sharp/branches

## Quick contributing guide

- Fork and clone locally
- Create a topic specific branch. Add some nice feature. Do not forget the tests ;-)
- Send a Pull Request to spread the fun!

More thorough information available in the [wiki][16].
More thorough information available in the [wiki][wiki].

[16]: https://github.com/libgit2/libgit2sharp/wiki
[wiki]: https://github.com/libgit2/libgit2sharp/wiki

## Authors

- **Code:** The LibGit2Sharp [contributors][17]
- **Logo:** [Jason "blackant" Long][18]
- **Code:** The LibGit2Sharp [contributors][committers]
- **Logo:** [Jason "blackant" Long][blackant]

[17]: https://github.com/libgit2/libgit2sharp/contributors
[18]: https://github.com/jasonlong
[committers]: https://github.com/libgit2/libgit2sharp/contributors
[blackant]: https://github.com/jasonlong

## License

The MIT license (Refer to the [LICENSE.md][19] file)
The MIT license (Refer to the [LICENSE.md][license] file)

[19]: https://github.com/libgit2/libgit2sharp/blob/master/LICENSE.md
[license]: https://github.com/libgit2/libgit2sharp/blob/master/LICENSE.md