Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
Signed-off-by: Utku Ozdemir <uoz@protonmail.com>
  • Loading branch information
utkuozdemir committed Jun 12, 2021
1 parent d9fbef9 commit f8648cc
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,32 @@ However, this one is written in Go to produce a single, static binary.

This makes it possible to run it on Windows and get GPU metrics while gaming - no Docker or Linux required.

## Installation

### Using Scoop (Windows)
If you use [Scoop package manager](https://scoop.sh) on Windows,
run the following commands in a command prompt (CMD/Powershell):
```powershell
scoop bucket add utkuozdemir https://github.com/utkuozdemir/scoop_nvidia_gpu_exporter.git
scoop install utkuozdemir/nvidia_gpu_exporter
```

### By downloading the binaries (MacOS/Linux/Windows)

1. Go to the [releases](https://github.com/utkuozdemir/nvidia_gpu_exporter/releases) and download
the latest release archive for your platform.
2. Extract the archive.
3. Move the binary to somewhere in your `PATH`.

Sample steps for Linux 64-bit:
```bash
$ VERSION=0.1.1
$ wget https://github.com/utkuozdemir/nvidia_gpu_exporter/releases/download/v${VERSION}/nvidia_gpu_exporter_${VERSION}_linux_x86_64.tar.gz
$ tar -xvzf nvidia_gpu_exporter_${VERSION}_linux_x86_64.tar.gz
$ mv nvidia_gpu_exporter /usr/local/bin
$ nvidia_gpu_exporter --help
```

## Usage

The usage of the binary is the following:
Expand Down

0 comments on commit f8648cc

Please sign in to comment.