Skip to content

Commit 1b0d15a

Browse files
committed
docs: mention nerdfonts requirement; update benchmarks section
1 parent 3960b37 commit 1b0d15a

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -47,15 +47,17 @@ Fastfetch, as its name indicates, a very fast fetch tool written in C, however,
4747
I am not interested in any of its additional features and I very much dislike
4848
the defaults. Microfetch is a fetch tool that you would normally write in Bash
4949
and put in your `~/.bashrc` but actually _really_ fast because it opts-out of
50-
all customization options provided by Fastfetch. Why? Because I can.
50+
all customization options provided by Fastfetch. Why? Because I can, and because
51+
I prefer Rust for "structured" Bash scripts.
5152

5253
I cannot re-iterate it enough, Microfetch is annoyingly fast.
5354

5455
## Benchmarks
5556

56-
Microfetch's performance is mostly hardware-dependant, however, the overall
57-
trend seems to be < 2ms on any modern (2015 and after) CPU. Below are the
58-
benchmarks with Hyperfine on my desktop system.
57+
Microfetch's performance is capped by hardware-specific race conditions, meaning
58+
it may (at times) depend on your hardware. However, the overall trend seems to
59+
be < 2ms on any modern (2015 and after) CPU. Below are the benchmarks with
60+
Hyperfine on my desktop system.
5961

6062
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative | Written by raf? |
6163
| :----------- | ----------: | -------: | -------: | -------------: | --------------: |
@@ -65,7 +67,7 @@ benchmarks with Hyperfine on my desktop system.
6567
| `neofetch` | 735.4 ± 9.5 | 721.1 | 752.8 | 555.48 ± 19.08 | no |
6668

6769
_As far as I'm concerned, Microfetch is faster than almost every fetch tool
68-
there is. The only downside of using Rust is introducing more "bloated"
70+
there is. The only downsides of using Rust are introducing more "bloated"
6971
dependency trees and increasing build times. The latter is easily mitigated with
7072
Nix's binary cache, though._
7173

@@ -78,6 +80,10 @@ features of Microfetch.
7880

7981
## Installation
8082

83+
> [!NOTE]
84+
> You will need a Nerdfonts patched font installed, and for your terminal
85+
> emulator to support said font. Microfetch uses nerdfonts glyphs by default.
86+
8187
Microfetch is packaged in [nixpkgs](https://github.com/nixos/nixpkgs). You can
8288
get it through the unstable channel for the time being. The Nix flake can also
8389
be used for bleeding-edge builds.

0 commit comments

Comments
 (0)