NotAShelf/microfetch
1
1
Fork 0
mirror of https://github.com/NotAShelf/microfetch.git synced 2024-11-22 15:40:41 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

include installation instructions

Browse source
This commit is contained in:
raf 2024-08-14 00:19:40 +03:00
parent 58c6d9b384
commit 6cad15c330
Signed by: NotAShelf
GPG key ID: AF26552424E53993
1 changed files with 13 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
README.md
View file

@ -35,12 +35,23 @@ than welcome to use it on your system: it's pretty [fast...](#benchmarks)
- Version - Version
- Architecture - Architecture
- Current shell (from $SHELL, trimmed if store path) - 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 - Memory Usage/Total Memory
- Storage Usage/Total Storage (for `/` only) - Storage Usage/Total Storage (for `/` only)
- Shell Colors - Shell Colors
- Did I mention fast? - 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 ## Benchmarks
Microfetch's performance is mostly hardware-dependant, however, the overall 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. benchmarks with Hyperfine on my desktop system.
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative | Written by raf? | | Command | Mean [ms] | Min [ms] | Max [ms] | Relative | Written by raf? |
| :----------- | ----------: | -------: | -------: | -------------: | ----------------: | :----------- | ----------: | -------: | -------: | -------------: | --------------: |
| `microfetch` | 1.3 ± 0.0 | 1.3 | 1.4 | 1.00 | yes | | `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 | | `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 | | `neofetch` | 735.4 ± 9.5 | 721.1 | 752.8 | 555.48 ± 19.08 | no |