Skip to content

Commit

Permalink
chore: updates to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
alphastrata committed Oct 9, 2023
1 parent ecfd935 commit 0a48367
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,16 @@ ______________________________________________________________________

# Usage:

```
```shell
# Monitor the GPU and system with a 1-second update interval
nvtop --delay 1000
```

```shell
# 1-second just so happens to be the default so, if you're happy with that you can just run:
nvtop
```

______________________________________________________________________

### Prerequisites
Expand All @@ -48,6 +53,8 @@ You can install `nvtop` directly from Cargo. Follow these steps:
1. Build and install `nvtop` from GitHub:

```bash
cargo install nvtop
# or for the latest you can use a git url,
cargo install --git https://github.com/alphastrata/nvtop
```

Expand All @@ -71,6 +78,7 @@ To build `nvtop` from the source code, you can follow these steps:

```bash
cargo build --release
# the binary will be available at ./target/release/nvtop
```

1. After building, you can find the `nvtop` executable in the `target/release/` directory.
Expand Down

0 comments on commit 0a48367

Please sign in to comment.