Skip to content

Commit ab9debe

Browse files
committed
docs: reorganize installation instructions
1 parent da4b696 commit ab9debe

1 file changed

Lines changed: 51 additions & 41 deletions

File tree

readme.md

Lines changed: 51 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,17 @@ gitnr search
2121
## Table of Contents
2222

2323
- [Installation](#install--update)
24-
- [Linux & Mac](#linux--mac)
25-
- [Windows](#windows)
26-
- [Cargo](#cargo)
27-
- [Cargo Binstall](#cargo-binstall)
28-
- [Binary Download](#binary-download)
29-
- [NetBSD](#NetBSD)
30-
- [Homebrew](#homebrew)
31-
- [From Source](#from-source)
24+
- [Package Managers](#package-managers)
25+
- [Homebrew (macOS / Linux)](#homebrew-macos--linux)
26+
- [Cargo](#cargo)
27+
- [Cargo Binstall](#cargo-binstall)
28+
- [NetBSD](#netbsd)
29+
- [Install Scripts](#install-scripts)
30+
- [Linux & macOS](#linux--macos)
31+
- [Windows](#windows)
32+
- [Manual Install](#manual-install)
33+
- [Binary Download](#binary-download)
34+
- [From Source](#from-source)
3235
- [Usage](#usage)
3336
- [Create](#create)
3437
- [Search](#search)
@@ -37,70 +40,77 @@ gitnr search
3740

3841
## Install & Update
3942

40-
### Linux & Mac
43+
### Package Managers
4144

42-
Run any of the commands below in your terminal to get the latest version of `gitnr`.
45+
#### Homebrew (macOS / Linux)
4346

44-
**Install system-wide**
45-
```sh
46-
curl -s https://raw.githubusercontent.com/reemus-dev/gitnr/main/scripts/install.sh | sudo bash -s
47-
```
47+
Install the latest version using Homebrew with the command below.
4848

49-
**Install for current user**
5049
```sh
51-
curl -s https://raw.githubusercontent.com/reemus-dev/gitnr/main/scripts/install.sh | bash -s -- -u
50+
brew install gitnr
5251
```
5352

54-
_On Linux this defaults to `$HOME/.local/bin` and on macOS to `$HOME/bin`. The script will fail if the directory doesn't exist or is not in your system path._
53+
#### Cargo
54+
55+
Install and compile the latest version from crates.io with the command below.
5556

56-
**Install in specific directory**
5757
```sh
58-
curl -s https://raw.githubusercontent.com/reemus-dev/gitnr/main/scripts/install.sh | bash -s -- -d <dir>
58+
cargo install gitnr
5959
```
6060

61-
### Windows
61+
#### Cargo Binstall
6262

63-
Run the command below in a PowerShell terminal to install the latest version of `gitnr`.
63+
Install the binary directly using `cargo-binstall`.
6464

65-
```powershell
66-
Set-ExecutionPolicy Unrestricted -Scope Process; iex (iwr "https://raw.githubusercontent.com/reemus-dev/gitnr/main/scripts/install.ps1").Content
65+
```sh
66+
cargo-binstall gitnr
6767
```
6868

69-
### Cargo
70-
71-
Install and compile the latest version from crates.io with the command below.
69+
#### NetBSD
7270

71+
On NetBSD a pre-compiled binary is available from the official repositories. To install it, simply run:
7372
```sh
74-
cargo install gitnr
73+
pkgin install gitnr
7574
```
7675

77-
### Cargo Binstall
76+
### Install Scripts
7877

79-
Install the binary directly using `cargo-binstall`.
78+
#### Linux & macOS
8079

80+
Run any of the commands below in your terminal to get the latest version of `gitnr`.
81+
82+
**Install system-wide**
8183
```sh
82-
cargo-binstall gitnr
84+
curl -s https://raw.githubusercontent.com/reemus-dev/gitnr/main/scripts/install.sh | sudo bash -s
8385
```
8486

85-
### Binary Download
86-
87-
See the [releases page](https://github.com/reemus-dev/gitnr/releases) to download a binary and then add it to a directory in your system path.
87+
**Install for current user**
88+
```sh
89+
curl -s https://raw.githubusercontent.com/reemus-dev/gitnr/main/scripts/install.sh | bash -s -- -u
90+
```
8891

89-
### NetBSD
92+
_On Linux this defaults to `$HOME/.local/bin` and on macOS to `$HOME/bin`. The script will fail if the directory doesn't exist or is not in your system path._
9093

91-
On NetBSD a pre-compiled binary is available from the official repositories. To install it, simply run:
94+
**Install in specific directory**
9295
```sh
93-
pkgin install gitnr
96+
curl -s https://raw.githubusercontent.com/reemus-dev/gitnr/main/scripts/install.sh | bash -s -- -d <dir>
9497
```
9598

96-
### Homebrew
99+
#### Windows
97100

98-
You can also install the latest version using Homebrew:
99-
```sh
100-
brew install gitnr
101+
Run the command below in a PowerShell terminal to install the latest version of `gitnr`.
102+
103+
```powershell
104+
Set-ExecutionPolicy Unrestricted -Scope Process; iex (iwr "https://raw.githubusercontent.com/reemus-dev/gitnr/main/scripts/install.ps1").Content
101105
```
102106

103-
### From Source
107+
### Manual Install
108+
109+
#### Binary Download
110+
111+
See the [releases page](https://github.com/reemus-dev/gitnr/releases) to download a binary and then add it to a directory in your system path.
112+
113+
#### From Source
104114

105115
```sh
106116
git clone --depth=1 github.com/reemus-dev/gitnr

0 commit comments

Comments
 (0)