Skip to content

Commit 961331d

Browse files
committed
More README tweaks
1 parent adb70a2 commit 961331d

File tree

1 file changed

+23
-11
lines changed

1 file changed

+23
-11
lines changed

README.md

Lines changed: 23 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -19,49 +19,59 @@ the following platforms:
1919

2020
## Script overview
2121

22-
The following scripts are used build and update this repo.
22+
The following scripts are used to build libgit2 and update this repo.
2323

2424
### build.libgit2.ps1
2525

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.
2727

2828
To build x86 binaries:
2929

30-
`build.libgit2.ps1 -x86`
30+
```
31+
build.libgit2.ps1 -x86
32+
```
3133

3234
To build x64 binaries:
3335

34-
`build.libgit2.ps1 -x64`
36+
```
37+
build.libgit2.ps1 -x64
38+
```
3539

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.
3741

3842
### build.libgit2.sh
3943

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.
4145

4246
### dockerbuild.sh
4347

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.
4549

4650
### UpdateLibgit2ToSha.ps1
4751

4852
This script is used to update the libgit2 submodule and update the references within the project to the correct libgit2 revision.
4953

5054
You can update to a specific commit:
5155

52-
`UpdateLibgit2ToSha.ps1 1a2b3c4`
56+
```
57+
UpdateLibgit2ToSha.ps1 1a2b3c4
58+
```
5359

5460
Or you can specify references:
5561

56-
`UpdateLibgit2ToSha.ps1 master`
62+
```
63+
UpdateLibgit2ToSha.ps1 master
64+
```
5765

5866
## Building the package locally
5967

6068
After running the appropriate build script(s) to create binaries, the NuGet package needs to be created.
6169

6270
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:
6371

64-
'dotnet tool install --global minver-cli`
72+
```
73+
dotnet tool install --global minver-cli
74+
```
6575

6676
Once that is installed, running the `minver` command will output a version:
6777

@@ -73,7 +83,9 @@ MinVer: Calculated version 2.0.313-alpha.0.3.
7383

7484
To create the package, use the the following command:
7585

76-
`nuget.exe Pack nuget.package/NativeBinaries.nuspec -Version <version> -NoPackageAnalysis`
86+
```
87+
nuget.exe Pack nuget.package/NativeBinaries.nuspec -Version <version> -NoPackageAnalysis
88+
```
7789

7890
Where `<version>` is the version from the MinVer tool or manually chosen version.
7991

0 commit comments

Comments
 (0)