-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
I'M AN IDIOT
- Loading branch information
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Large diffs are not rendered by default.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
The MIT License | ||
|
||
Copyright (c) LibGit2Sharp contributors | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in | ||
all copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
THE SOFTWARE. |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,99 @@ | ||
# LibGit2Sharp | ||
|
||
**LibGit2Sharp brings all the might and speed of [libgit2][libgit2], a native Git implementation, to the managed world of .NET and Mono.** | ||
|
||
[libgit2]: http://libgit2.github.com/ | ||
|
||
## Prerequisites | ||
|
||
- **Windows:** .NET 4.0+ | ||
- **Linux/Mac OS X:** Mono 3.6+ | ||
|
||
## Online resources | ||
|
||
- [NuGet package][nuget] (Requires NuGet 2.7+) | ||
- [Source code][source] | ||
|
||
[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][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]) | ||
|
||
[so]: http://stackoverflow.com/questions/tagged/libgit2sharp | ||
[tracker]: https://github.com/libgit2/libgit2sharp/issues | ||
[twitter]: http://twitter.com/libgit2sharp | ||
|
||
## Current project status | ||
|
||
The CI builds are generously hosted and run on the [Travis][travis] and [AppVeyor][appveyor] infrastructures. | ||
|
||
| | Windows (x86/amd64) | Linux/Mac OS X | | ||
| :------ | :------: | :------: | | ||
| **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] | | ||
|
||
The security-oriented static code analysis is kindly run through the [Coverity][coverity] service. Code coverage is kindly run through [Coveralls.io][coveralls]. | ||
|
||
| | Static Analysis | Code Coverage | | ||
|-------|-----------------|---------------| | ||
| **vNext** | [![coverity][coverity-badge]][coverity-project] | [![coveralls][coveralls-badge]][coveralls-project] | | ||
|
||
|
||
[travis]: https://travis-ci.org/ | ||
[appveyor]: http://appveyor.com/ | ||
[coverity]: https://scan.coverity.com/ | ||
[coveralls]: https://coveralls.io/ | ||
|
||
[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 | ||
|
||
[coverity-project]: https://scan.coverity.com/projects/2088 | ||
[coverity-badge]: https://scan.coverity.com/projects/2088/badge.svg | ||
|
||
[coveralls-project]: https://coveralls.io/r/libgit2/libgit2sharp?branch=vNext | ||
[coveralls-badge]: https://coveralls.io/repos/libgit2/libgit2sharp/badge.svg?branch=vNext | ||
|
||
## 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][wiki]. | ||
|
||
[wiki]: https://github.com/libgit2/libgit2sharp/wiki | ||
|
||
## Optimizing unit testing | ||
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. | ||
|
||
You can do a few things to optimize running unit-tests on Windows: | ||
|
||
1. Set the `LibGit2TestPath` environment variable to a path in your development environment. | ||
* If the unit-test framework cannot find the specified folder at runtime, it will fall back to the default location. | ||
2. Configure your anti-virus software to ignore the `LibGit2TestPath` path. | ||
3. Install a RAM disk like [IMDisk](http://www.ltr-data.se/opencode.html/#ImDisk) and set `LibGit2TestPath` to use it. | ||
* Use `imdisk.exe -a -s 512M -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. | ||
|
||
## Authors | ||
|
||
- **Code:** The LibGit2Sharp [contributors][committers] | ||
- **Logo:** [Jason "blackant" Long][blackant] | ||
|
||
[committers]: https://github.com/libgit2/libgit2sharp/contributors | ||
[blackant]: https://github.com/jasonlong | ||
|
||
## License | ||
|
||
The MIT license (Refer to the [LICENSE.md][license] file) | ||
|
||
[license]: https://github.com/libgit2/libgit2sharp/blob/master/LICENSE.md |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.