Skip to content

Commit 5bf6394

Browse files
committed
Added note in readme about compatibility with mono, also documented fix for GitTools#1099
1 parent 2d2da32 commit 5bf6394

File tree

3 files changed

+18
-1
lines changed

3 files changed

+18
-1
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,13 @@ Versioning when using git, solved. GitVersion looks at your git history and work
1515
|NuGet (GitVersion.CommandLine)|[![NuGet](https://img.shields.io/nuget/v/GitVersion.CommandLine.svg)](https://www.nuget.org/packages/GitVersion.CommandLine)|[![NuGet](https://img.shields.io/nuget/vpre/GitVersion.CommandLine.svg)](https://www.nuget.org/packages/GitVersion.CommandLine)|
1616
|Gem|[![Gem](https://img.shields.io/gem/v/gitversion.svg)](https://rubygems.org/gems/gitversion)|[![Gem](https://img.shields.io/gem/v/gitversion.svg)](https://rubygems.org/gems/gitversion)|
1717

18+
## Compatibility
19+
GitVersion works on Mac, Linux with Mono and Windows.
20+
21+
Tip: If you get `System.TypeInitializationException: The type initializer for 'LibGit2Sharp.Core.NativeMethods' threw an exception. ---> System.DllNotFoundException: lib/linux/x86_64/libgit2-baa87df.so`
22+
23+
You likely need to install `libcurl3`. Run `sudo get-get install libcurl3`
24+
1825
## Quick Links
1926
- [Documentation](http://gitversion.readthedocs.org/en/latest)
2027
- [Contributing](https://github.com/GitTools/GitVersion/blob/master/CONTRIBUTING.md)

docs/index.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,13 @@ GitVersion is a tool to help you achieve *Semantic Versioning* on your project.
33

44
This influences many of the decisions GitVersion has made, please read and understand this page as it will help you start using GitVersion effectively!
55

6+
## Compatibility
7+
GitVersion works on Mac, Linux with Mono and Windows.
8+
9+
Tip: If you get `System.TypeInitializationException: The type initializer for 'LibGit2Sharp.Core.NativeMethods' threw an exception. ---> System.DllNotFoundException: lib/linux/x86_64/libgit2-baa87df.so`
10+
11+
You likely need to install `libcurl3`. Run `sudo get-get install libcurl3`
12+
613
## Assumptions/Rules
714
### Tags override other rules
815
If a commit is tagged, then GitVersion will *always* use that version over any calculated versions. This is so if you rebuild a tag then the same version will be produced.

docs/usage/command-line.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,4 +64,7 @@ At the moment only `tag-prefix` option is supported. Read more about [Configurat
6464
It will not change config file 'GitVersion.yml'.
6565

6666
### Example: How to override configuration option 'tag-prefix' to use prefix 'custom'
67-
`GitVersion.exe /output json /overrideconfig tag-prefix=custom`
67+
`GitVersion.exe /output json /overrideconfig tag-prefix=custom`
68+
69+
## Mono
70+
To use on mac or linux, install `mono-complete` then just run `mono GitVersion.exe`

0 commit comments

Comments
 (0)