Skip to content

Commit 2d53f13

Browse files
authored
Merge pull request #19 from axkoro/main
docs: add homebrew installation and reorganize installation section
2 parents 34efb72 + ab9debe commit 2d53f13

1 file changed

Lines changed: 51 additions & 33 deletions

File tree

readme.md

Lines changed: 51 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +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-
- [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)
3135
- [Usage](#usage)
3236
- [Create](#create)
3337
- [Search](#search)
@@ -36,7 +40,42 @@ gitnr search
3640

3741
## Install & Update
3842

39-
### Linux & Mac
43+
### Package Managers
44+
45+
#### Homebrew (macOS / Linux)
46+
47+
Install the latest version using Homebrew with the command below.
48+
49+
```sh
50+
brew install gitnr
51+
```
52+
53+
#### Cargo
54+
55+
Install and compile the latest version from crates.io with the command below.
56+
57+
```sh
58+
cargo install gitnr
59+
```
60+
61+
#### Cargo Binstall
62+
63+
Install the binary directly using `cargo-binstall`.
64+
65+
```sh
66+
cargo-binstall gitnr
67+
```
68+
69+
#### NetBSD
70+
71+
On NetBSD a pre-compiled binary is available from the official repositories. To install it, simply run:
72+
```sh
73+
pkgin install gitnr
74+
```
75+
76+
### Install Scripts
77+
78+
#### Linux & macOS
4079

4180
Run any of the commands below in your terminal to get the latest version of `gitnr`.
4281

@@ -57,42 +96,21 @@ _On Linux this defaults to `$HOME/.local/bin` and on macOS to `$HOME/bin`. The s
5796
curl -s https://raw.githubusercontent.com/reemus-dev/gitnr/main/scripts/install.sh | bash -s -- -d <dir>
5897
```
5998

60-
### Windows
99+
#### Windows
61100

62101
Run the command below in a PowerShell terminal to install the latest version of `gitnr`.
63102

64103
```powershell
65104
Set-ExecutionPolicy Unrestricted -Scope Process; iex (iwr "https://raw.githubusercontent.com/reemus-dev/gitnr/main/scripts/install.ps1").Content
66105
```
67106

68-
### Cargo
69-
70-
Install and compile the latest version from crates.io with the command below.
71-
72-
```sh
73-
cargo install gitnr
74-
```
75-
76-
### Cargo Binstall
107+
### Manual Install
77108

78-
Install the binary directly using `cargo-binstall`.
79-
80-
```sh
81-
cargo-binstall gitnr
82-
```
83-
84-
### Binary Download
109+
#### Binary Download
85110

86111
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.
87112

88-
### NetBSD
89-
90-
On NetBSD a pre-compiled binary is available from the official repositories. To install it, simply run:
91-
```sh
92-
pkgin install gitnr
93-
```
94-
95-
### From Source
113+
#### From Source
96114

97115
```sh
98116
git clone --depth=1 github.com/reemus-dev/gitnr

0 commit comments

Comments
 (0)