NotAShelf/microfetch
1
1
Fork 0
mirror of https://github.com/NotAShelf/microfetch.git synced 2024-12-28 04:42:22 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: mention nerdfonts requirement; update benchmarks section
Some checks failed
Rust / build (push) Has been cancelled
Details

Browse source
This commit is contained in:
raf 2024-12-10 21:26:14 +03:00
parent 3960b37089
commit 1b0d15a24f
Signed by: NotAShelf
GPG key ID: AF26552424E53993
1 changed files with 11 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -47,15 +47,17 @@ Fastfetch, as its name indicates, a very fast fetch tool written in C, however,
I am not interested in any of its additional features and I very much dislike
the defaults. Microfetch is a fetch tool that you would normally write in Bash
and put in your `~/.bashrc` but actually _really_ fast because it opts-out of
all customization options provided by Fastfetch. Why? Because I can.
all customization options provided by Fastfetch. Why? Because I can, and because
I prefer Rust for "structured" Bash scripts.
I cannot re-iterate it enough, Microfetch is annoyingly fast.
## Benchmarks
Microfetch's performance is mostly hardware-dependant, however, the overall
trend seems to be < 2ms on any modern (2015 and after) CPU. Below are the
benchmarks with Hyperfine on my desktop system.
Microfetch's performance is capped by hardware-specific race conditions, meaning
it may (at times) depend on your hardware. However, the overall 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? |
| :----------- | ----------: | -------: | -------: | -------------: | --------------: |
@ -65,7 +67,7 @@ benchmarks with Hyperfine on my desktop system.
| `neofetch` | 735.4 ± 9.5 | 721.1 | 752.8 | 555.48 ± 19.08 | no |
_As far as I'm concerned, Microfetch is faster than almost every fetch tool
there is. The only downside of using Rust is introducing more "bloated"
there is. The only downsides of using Rust are introducing more "bloated"
dependency trees and increasing build times. The latter is easily mitigated with
Nix's binary cache, though._
@ -78,6 +80,10 @@ features of Microfetch.
## Installation
> [!NOTE]
> You will need a Nerdfonts patched font installed, and for your terminal
> emulator to support said font. Microfetch uses nerdfonts glyphs by default.
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.