Skip to content

Commit 5e97775

Browse files
authored
Clarify building from source on Windows
Address cli#2545 (comment)
1 parent 8b5c589 commit 5e97775

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

docs/source.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,16 +17,23 @@
1717

1818
2. Build and install
1919

20+
#### Unix-like systems
2021
```sh
2122
# installs to '/usr/local' by default; sudo may be required
2223
$ make install
24+
25+
# install to a different location
26+
$ make install prefix=/path/to/gh
2327
```
2428

25-
To install to a different location:
29+
#### Windows
2630
```sh
27-
$ make install prefix=/path/to/gh
31+
# build the binary
32+
> go build -o gh.exe ./cmd/gh
2833
```
29-
30-
Make sure that the `${prefix}/bin` directory is in your PATH.
34+
There is no install step available on Windows.
3135

3236
3. Run `gh version` to check if it worked.
37+
38+
#### Windows
39+
Run `.\gh version` to check if it worked.

0 commit comments

Comments
 (0)