Skip to content

Commit a557593

Browse files
committed
Update README
1 parent d9777fc commit a557593

File tree

1 file changed

+19
-52
lines changed

1 file changed

+19
-52
lines changed

README.md

+19-52
Original file line numberDiff line numberDiff line change
@@ -1,78 +1,45 @@
11
# LibGit2Sharp
22

3-
[![master azurepipelines][master-azurepipelines-badge]][master-azurepipelines]
4-
[![master win][master-win-badge]][master-win]
5-
[![master nix][master-nix-badge]][master-nix]
6-
[![coverity][coverity-badge]][coverity-project]
3+
![master CI](https://github.com/libgit2/libgit2sharp/actions/workflows/ci.yml/badge.svg)
74

8-
[master-azurepipelines-badge]: https://dev.azure.com/libgit2sharp/libgit2sharp/_apis/build/status/libgit2sharp?branchName=master
9-
[master-azurepipelines]: https://dev.azure.com/libgit2sharp/libgit2sharp/_build/latest?definitionId=1
10-
[master-win-badge]: https://ci.appveyor.com/api/projects/status/8qxcoqdo9kp7x2w9/branch/master?svg=true
11-
[master-win]: https://ci.appveyor.com/project/libgit2/libgit2sharp/branch/master
12-
[master-nix-badge]: https://travis-ci.org/libgit2/libgit2sharp.svg?branch=master
13-
[master-nix]: https://travis-ci.org/libgit2/libgit2sharp/branches
14-
15-
[coverity-project]: https://scan.coverity.com/projects/2088
16-
[coverity-badge]: https://scan.coverity.com/projects/2088/badge.svg
17-
18-
**LibGit2Sharp brings all the might and speed of [libgit2][libgit2], a native Git implementation, to the managed world of .NET and Mono.**
19-
20-
[libgit2]: http://libgit2.github.com/
21-
22-
## Prerequisites
23-
24-
- **Windows:** .NET 4.6.1+
25-
- **Linux/Mac OS X:** Mono 5.4+
5+
**LibGit2Sharp brings all the might and speed of [libgit2](http://libgit2.github.com/), a native Git implementation, to the managed world of .NET**
266

277
## Online resources
288

29-
- [NuGet package][nuget] (Requires NuGet 2.7+)
30-
- [Source code][source]
31-
32-
[nuget]: http://nuget.org/List/Packages/LibGit2Sharp
33-
[source]: https://github.com/libgit2/libgit2sharp/
9+
- [NuGet package](http://nuget.org/List/Packages/LibGit2Sharp)
10+
- [Source code](https://github.com/libgit2/libgit2sharp/)
3411

3512
## Troubleshooting and support
3613

37-
- Usage or programming related question? Post it on [StackOverflow][so] using the tag *libgit2sharp*
38-
- Found a bug or missing a feature? Feed the [issue tracker][tracker]
39-
- Announcements and related miscellanea through Twitter ([@libgit2sharp][twitter])
40-
41-
[so]: http://stackoverflow.com/questions/tagged/libgit2sharp
42-
[tracker]: https://github.com/libgit2/libgit2sharp/issues
43-
[twitter]: http://twitter.com/libgit2sharp
14+
- Usage or programming related question? Post it on [StackOverflow](http://stackoverflow.com/questions/tagged/libgit2sharp) using the tag *libgit2sharp*
15+
- Found a bug or missing a feature? Feed the [issue tracker](https://github.com/libgit2/libgit2sharp/issues)
16+
- Announcements and related miscellanea through Twitter ([@libgit2sharp](http://twitter.com/libgit2sharp))
4417

4518
## Quick contributing guide
4619

47-
- Fork and clone locally
48-
- Create a topic specific branch. Add some nice feature. Do not forget the tests ;-)
49-
- Send a Pull Request to spread the fun!
50-
51-
More thorough information available in the [wiki][wiki].
20+
- Fork and clone locally
21+
- Create a topic specific branch. Add some nice feature. Do not forget the tests ;-)
22+
- Send a Pull Request to spread the fun!
5223

53-
[wiki]: https://github.com/libgit2/libgit2sharp/wiki
24+
More thorough information is available in the [wiki](https://github.com/libgit2/libgit2sharp/wiki).
5425

5526
## Optimizing unit testing
56-
LibGit2Sharp strives to have comprehensive and robust unit test suite to ensure 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.
5727

58-
You can do a few things to optimize running unit-tests on Windows:
28+
LibGit2Sharp strives to have a comprehensive and robust unit test suite to ensure the quality of the software and to assist new contributors and users, who can use the tests as examples to jump start development. There are over one thousand unit tests for LibGit2Sharp, and this number will only grow as functionality is added.
29+
30+
You can do a few things to optimize running unit tests on Windows:
5931

6032
1. Set the `LibGit2TestPath` environment variable to a path in your development environment.
61-
* If the unit-test framework cannot find the specified folder at runtime, it will fall back to the default location.
33+
* If the unit test framework cannot find the specified folder at runtime, it will fall back to the default location.
6234
2. Configure your anti-virus software to ignore the `LibGit2TestPath` path.
6335
3. Install a RAM disk like [IMDisk](http://www.ltr-data.se/opencode.html/#ImDisk) and set `LibGit2TestPath` to use it.
64-
* 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.
36+
* 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.
6537

6638
## Authors
6739

68-
- **Code:** The LibGit2Sharp [contributors][committers]
69-
- **Logo:** [Jason "blackant" Long][blackant]
70-
71-
[committers]: https://github.com/libgit2/libgit2sharp/contributors
72-
[blackant]: https://github.com/jasonlong
40+
- **Code:** The LibGit2Sharp [contributors](https://github.com/libgit2/libgit2sharp/contributors)
41+
- **Logo:** [Jason "blackant" Long](https://github.com/jasonlong)
7342

7443
## License
7544

76-
The MIT license (Refer to the [LICENSE.md][license] file)
77-
78-
[license]: https://github.com/libgit2/libgit2sharp/blob/master/LICENSE.md
45+
The MIT license (Refer to the [LICENSE.md](https://github.com/libgit2/libgit2sharp/blob/master/LICENSE.md) file)

0 commit comments

Comments
 (0)