diff options
| author | Clement Tsang <34804052+ClementTsang@users.noreply.github.com> | 2021-08-15 22:01:31 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-08-15 22:01:31 -0400 |
| commit | 2c8aea9eef696ecec7d999d9da62ed8c5cb2a09c (patch) | |
| tree | 3999c1b81480871bc13457bbe2d3b08ef40300ef /README.md | |
| parent | f185c09c7e64b634212e7226231b4a946441c982 (diff) | |
docs: Some minor wording changes in the README
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 21 |
1 files changed, 11 insertions, 10 deletions
@@ -190,34 +190,35 @@ and installing via the `.msi` file. You can uninstall via Control Panel, Options, or `winget --uninstall bottom`. -### Building +### Manually -There are a few ways to go about doing this manually. Note that in all cases, you would want to build using the most recent version of stable Rust: +There are a few ways to go about doing this manually. Note that you probably want +to do so using the most recent version of stable Rust, which is how the binaries are built: ```bash -# If required, update Rust on the stable channel +# If required, update Rust on the stable channel first rustup update stable -# Download from releases and install +# Option 1 - Download from releases and install curl -LO https://github.com/ClementTsang/bottom/archive/0.6.3.tar.gz tar -xzvf 0.6.3.tar.gz cargo install --path . -# Clone from master and install manually +# Option 2 - Clone from master and install manually git clone https://github.com/ClementTsang/bottom cd bottom cargo install --path . -# Clone and install the newest master version all via Cargo +# Option 3 - Clone and install directly from the repo all via Cargo cargo install --git https://github.com/ClementTsang/bottom ``` ### Binaries -You can also try to use the generated release binaries and manually install them: +You can also try to use the generated release binaries and manually install on your system: - [Latest stable release](https://github.com/ClementTsang/bottom/releases/latest), generated off of the release branch -- [Latest nightly version](https://github.com/ClementTsang/bottom/releases/tag/nightly), which is generated daily off of the master branch at 00:00 UTC +- [Latest nightly release](https://github.com/ClementTsang/bottom/releases/tag/nightly), generated daily off of the master branch at 00:00 UTC #### Auto-completion @@ -234,9 +235,9 @@ The release binaries are packaged with shell auto-completion files for bash, fis You can run bottom using `btm`. - For help on flags, use `btm -h` for a quick overview or `btm --help` for more details. -- For info on key and mouse bindings, refer to the [documentation](https://clementtsang.github.io/bottom/nightly/) or press `?` inside bottom. +- For info on key and mouse bindings, press `?` inside bottom or refer to the [documentation](https://clementtsang.github.io/bottom/nightly/). -You can generally find more information on usage in the [documentation](https://clementtsang.github.io/bottom/nightly/). +You can find more information on usage in the [documentation](https://clementtsang.github.io/bottom/nightly/). ## Configuration |