Skip to content

Commit c1c5ac8

Browse files
authored
docs: lint source.md
Fixes: - MD022 / blanks-around-headings Headings should be surrounded by blank lines - MD031 / blanks-around-fences Fenced code blocks should be surrounded by blank lines
1 parent 3220ab5 commit c1c5ac8

1 file changed

Lines changed: 6 additions & 0 deletions

File tree

docs/source.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
3. Build and install
1919

2020
#### Unix-like systems
21+
2122
```sh
2223
# installs to '/usr/local' by default; sudo may be required, or sudo -E for configured go environments
2324
$ make install
@@ -27,15 +28,18 @@
2728
```
2829

2930
#### Windows
31+
3032
```pwsh
3133
# build the `bin\gh.exe` binary
3234
> go run script\build.go
3335
```
36+
3437
There is no install step available on Windows.
3538

3639
4. Run `gh version` to check if it worked.
3740

3841
#### Windows
42+
3943
Run `bin\gh version` to check if it worked.
4044

4145
## Cross-compiling binaries for different platforms
@@ -44,10 +48,12 @@ You can use any platform with Go installed to build a binary that is intended fo
4448
or CPU architecture. This is achieved by setting environment variables such as GOOS and GOARCH.
4549

4650
For example, to compile the `gh` binary for the 32-bit Raspberry Pi OS:
51+
4752
```sh
4853
# on a Unix-like system:
4954
$ GOOS=linux GOARCH=arm GOARM=7 CGO_ENABLED=0 make clean bin/gh
5055
```
56+
5157
```pwsh
5258
# on Windows, pass environment variables as arguments to the build script:
5359
> go run script\build.go clean bin\gh GOOS=linux GOARCH=arm GOARM=7 CGO_ENABLED=0

0 commit comments

Comments
 (0)