Skip to content

Commit 51be999

Browse files
authored
Revise setup documentation (#148)
Moved CLI samples to new subsection, fixed markup, and revised levels of section titles
1 parent 867b002 commit 51be999

File tree

1 file changed

+18
-15
lines changed

1 file changed

+18
-15
lines changed

docs/setup.md

Lines changed: 18 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,31 @@
11
## Install from Package managers
22

3-
## Cargo.io
3+
### Cargo.io
44

55
```sh
66
cargo install gitql
77
```
88

99
> Note that from version `0.10.0` onward installing from Cargo requires `Cmake` to be installed so it can build the dependencies.
1010
11-
## Winget on Windows
11+
### Winget on Windows
1212

1313
```sh
1414
winget install gitql
1515
```
1616

17-
## Scoop on Windows
17+
### Scoop on Windows
1818

1919
```sh
2020
scoop install gitql
2121
```
2222

23-
## Homebrew on MacOS and Linux
23+
### Homebrew on MacOS and Linux
2424

2525
```sh
2626
brew install gql
2727
```
2828

29-
# On Single repository
30-
gitql <repository_path>
31-
32-
# On multi repositories
33-
gitql --repo <repository_path> <repository_path> ...etc
34-
35-
# Or
36-
gitql -r <repository_path> <repository_path> ...etc
37-
```
38-
3929
## Download Binaries
4030

4131
From Github repository page you can download the right executable for your OS and Arch from the latest release
@@ -54,7 +44,20 @@ cargo run -- --repo <repository_path> <repository_path> ...etc
5444
cargo run -- -r <repository_path> <repository_path> ...etc
5545
```
5646

57-
# Command line arguments
47+
## Samples for using command line
48+
49+
```sh
50+
# On Single repository
51+
gitql <repository_path>
52+
53+
# On multi repositories
54+
gitql --repo <repository_path> <repository_path> ...etc
55+
56+
# Or
57+
gitql -r <repository_path> <repository_path> ...etc
58+
```
59+
60+
## Command line arguments
5861

5962
```
6063
Usage: gitql [OPTIONS]

0 commit comments

Comments
 (0)