Skip to content

Commit 3de8b5e

Browse files
committed
docs: add cargo install instructions to README
Signed-off-by: NotAShelf <raf@notashelf.dev> Change-Id: I2ff7d28036ef717fb8a5a29c0f98e3e86a6a6964
1 parent 303c09e commit 3de8b5e

1 file changed

Lines changed: 15 additions & 6 deletions

File tree

docs/README.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -210,16 +210,25 @@ Or run it directly with `nix run`
210210
nix run nixpkgs#microfetch
211211
```
212212

213-
Non-Nix users will have to build Microfetch with `cargo`. It is not published
214-
anywhere but I imagine you can use `cargo install --git` to install it from
215-
source.
213+
[crates.io]: https://crates.io/crates/microfetch
214+
215+
Non-Nix users, if they plan to run this for some reason, will need to build
216+
Microfetch from source or install it with `cargo`. Microfetch is published on
217+
[crates.io] and can be installed with `cargo install`.
216218

217219
```bash
218-
cargo install --git https://github.com/notashelf/microfetch.git
220+
# Get Microfetch from crates.io
221+
cargo install microfetch
219222
```
220223

221-
Microfetch is _currently_ not available anywhere else. Though, does it _really_
222-
have to be?
224+
### Other Distros
225+
226+
<!-- Remove & replace with "unofficial" warning if adding distro-specific instructions -->
227+
228+
To my knowledge, there is no package for (nor a reason to package) Microfetch
229+
but if you run a patched version for your distribution, feel free to leave your
230+
repository (AUR, COPR, etc.) here as reference for those that might be
231+
interested in Microfetch tailored to their distributions.
223232

224233
## Customizing
225234

0 commit comments

Comments
 (0)