Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: 📝 update instructions for source installation #585

Merged
merged 5 commits into from
Jun 30, 2024
Merged

docs: 📝 update instructions for source installation #585

Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
7bfdec4
docs: 📝 update instructions for source installation
minhtrancccp Jun 29, 2024
e03e541
docs: 📝 clarify the example in `Build from source` section
minhtrancccp Jun 29, 2024
fd8b511
docs: 📝 Expand `go install` section
minhtrancccp Jun 29, 2024
a293ee3
doc: 📝 simplify `cd` command
minhtrancccp Jun 30, 2024
cc63450
Merge branch 'noborus:master' into master
minhtrancccp Jun 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 11 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ ov is a terminal pager.
* 2.8. [nix (nixOS, Linux, or macOS)](#nix-(nixos,-linux,-or-macos))
* 2.9. [Binary](#binary)
* 2.10. [go install](#go-install)
* 2.11. [go get(details or developer version)](#go-get(details-or-developer-version))
* 2.11. [Build from source](#build-from-source)
* 2.12. [Completion](#completion)
* 2.12.1. [bash](#bash)
* 2.12.2. [zsh](#zsh)
Expand Down Expand Up @@ -199,13 +199,19 @@ It will be installed in $GOPATH/bin by the following command.
go install github.com/noborus/ov@latest
```

### 2.11. <a name='go-get(details-or-developer-version)'></a>go get(details or developer version)
Or to install the latest commit from master:

First of all, download only with the following command without installing it.
```console
go install github.com/noborus/ov@master
```

### 2.11. <a name='build-from-source'></a>Build from source

First of all, clone this repo with either `git clone` or `gh repo clone`, then `cd` to the directory, for example:

```console
go get -d github.com/noborus/ov
cd $GOPATH/src/github.com/noborus/ov
git clone https://github.com/noborus/ov.git
cd ./ov/
```

Next, to install to $GOPATH/bin, run the make install command.
Expand Down