You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+23-11Lines changed: 23 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,49 +19,59 @@ the following platforms:
19
19
20
20
## Script overview
21
21
22
-
The following scripts are used build and update this repo.
22
+
The following scripts are used to build libgit2 and update this repo.
23
23
24
24
### build.libgit2.ps1
25
25
26
-
This script builds Windows libgit2 binaries. This requires Visual Studio 2019.
26
+
This script builds Windows libgit2 binaries. It requires Visual Studio 2019 to run.
27
27
28
28
To build x86 binaries:
29
29
30
-
`build.libgit2.ps1 -x86`
30
+
```
31
+
build.libgit2.ps1 -x86
32
+
```
31
33
32
34
To build x64 binaries:
33
35
34
-
`build.libgit2.ps1 -x64`
36
+
```
37
+
build.libgit2.ps1 -x64
38
+
```
35
39
36
-
If both parameters are specified, both will be built. See the script for additional parameters.
40
+
If both parameters are specified, both architectures will be built. See the script for additional parameters.
37
41
38
42
### build.libgit2.sh
39
43
40
-
This script builds Linux and macOS binaries. It can be invoked directly, but for Linux binaries, dockerbuild.sh should be used instead.
44
+
This script builds Linux and macOS binaries. It can be invoked directly, but for Linux binaries, `dockerbuild.sh` should be used instead.
41
45
42
46
### dockerbuild.sh
43
47
44
-
This script will build one of the Dockerfiles in the repo. It chooses which one to run based on the value of the RID environment variable. Using docker to build the Linux binaries for the various RIDs ensures that a specific environment and distro is used.
48
+
This script will build one of the Dockerfiles in the repo. It chooses which one to run based on the value of the `RID` environment variable. Using docker to build the Linux binaries for the various RIDs ensures that a specific environment and distro is used.
45
49
46
50
### UpdateLibgit2ToSha.ps1
47
51
48
52
This script is used to update the libgit2 submodule and update the references within the project to the correct libgit2 revision.
49
53
50
54
You can update to a specific commit:
51
55
52
-
`UpdateLibgit2ToSha.ps1 1a2b3c4`
56
+
```
57
+
UpdateLibgit2ToSha.ps1 1a2b3c4
58
+
```
53
59
54
60
Or you can specify references:
55
61
56
-
`UpdateLibgit2ToSha.ps1 master`
62
+
```
63
+
UpdateLibgit2ToSha.ps1 master
64
+
```
57
65
58
66
## Building the package locally
59
67
60
68
After running the appropriate build script(s) to create binaries, the NuGet package needs to be created.
61
69
62
70
First, to use the same version locally that will be generated via CI, install the [minver-cli](https://www.nuget.org/packages/minver-cli) dotnet tool:
63
71
64
-
'dotnet tool install --global minver-cli`
72
+
```
73
+
dotnet tool install --global minver-cli
74
+
```
65
75
66
76
Once that is installed, running the `minver` command will output a version:
67
77
@@ -73,7 +83,9 @@ MinVer: Calculated version 2.0.313-alpha.0.3.
73
83
74
84
To create the package, use the the following command:
0 commit comments