From 6cad15c3304fd082010888462e5170bad1f81f6a Mon Sep 17 00:00:00 2001 From: NotAShelf Date: Wed, 14 Aug 2024 00:19:40 +0300 Subject: [PATCH] include installation instructions --- README.md | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b6e9d8f..f27384d 100644 --- a/README.md +++ b/README.md @@ -35,12 +35,23 @@ than welcome to use it on your system: it's pretty [fast...](#benchmarks) - Version - Architecture - Current shell (from $SHELL, trimmed if store path) - - WM/Compositor and display backend + - Current Desktop (DE/WM/Compositor and display backend) - Memory Usage/Total Memory - Storage Usage/Total Storage (for `/` only) - Shell Colors - Did I mention fast? +## Installation + +Microfetch is packaged in [nixpkgs](https://github.com/nixos/nixpkgs). You can +get it through the unstable channel for the time being. The Nix flake can also +be used for bleeding-edge builds. + +Non-Nix users will have to build Microfetch with `cargo`. + +Microfetch is _currently_ not available anywhere else. Though, does it _really_ +have to be? + ## Benchmarks Microfetch's performance is mostly hardware-dependant, however, the overall @@ -48,7 +59,7 @@ trend seems to be < 2ms on any modern (2015 and after) CPU. Below are the benchmarks with Hyperfine on my desktop system. | Command | Mean [ms] | Min [ms] | Max [ms] | Relative | Written by raf? | -| :----------- | ----------: | -------: | -------: | -------------: | ----------------: +| :----------- | ----------: | -------: | -------: | -------------: | --------------: | | `microfetch` | 1.3 ± 0.0 | 1.3 | 1.4 | 1.00 | yes | | `pfetch` | 254.2 ± 4.8 | 246.7 | 264.9 | 191.97 ± 7.10 | no | | `neofetch` | 735.4 ± 9.5 | 721.1 | 752.8 | 555.48 ± 19.08 | no |