From 74d5bba5bfd5b26c642d2200c05f20a263d1f29c Mon Sep 17 00:00:00 2001 From: Yukai Chou Date: Tue, 6 Jan 2026 00:19:32 +0800 Subject: [PATCH] Revise setup documentation Moved CLI samples to new subsection, fixed markup, and revised levels of section titles --- docs/setup.md | 33 ++++++++++++++++++--------------- 1 file changed, 18 insertions(+), 15 deletions(-) diff --git a/docs/setup.md b/docs/setup.md index b4786446..0e746cbb 100644 --- a/docs/setup.md +++ b/docs/setup.md @@ -1,6 +1,6 @@ ## Install from Package managers -## Cargo.io +### Cargo.io ```sh cargo install gitql @@ -8,34 +8,24 @@ cargo install gitql > Note that from version `0.10.0` onward installing from Cargo requires `Cmake` to be installed so it can build the dependencies. -## Winget on Windows +### Winget on Windows ```sh winget install gitql ``` -## Scoop on Windows +### Scoop on Windows ```sh scoop install gitql ``` -## Homebrew on MacOS and Linux +### Homebrew on MacOS and Linux ```sh brew install gql ``` -# On Single repository -gitql - -# On multi repositories -gitql --repo ...etc - -# Or -gitql -r ...etc -``` - ## Download Binaries 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 ...etc cargo run -- -r ...etc ``` -# Command line arguments +## Samples for using command line + +```sh +# On Single repository +gitql + +# On multi repositories +gitql --repo ...etc + +# Or +gitql -r ...etc +``` + +## Command line arguments ``` Usage: gitql [OPTIONS]