annotate README @ 3:f7c837561bfa default tip

color CPU by load
author Yasuri <yasuri@charliesmp.net>
date Sun, 04 Oct 2026 14:59:57 -0500
parents 4034cee64a58
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
4034cee64a58 add stuff
Yasuri <yasuri@charliesmp.net>
parents:
diff changeset
1 topfetch++
4034cee64a58 add stuff
Yasuri <yasuri@charliesmp.net>
parents:
diff changeset
2 ==========
4034cee64a58 add stuff
Yasuri <yasuri@charliesmp.net>
parents:
diff changeset
3
4034cee64a58 add stuff
Yasuri <yasuri@charliesmp.net>
parents:
diff changeset
4 A tiny live system monitor and fetch tool for Linux, written in C++.
4034cee64a58 add stuff
Yasuri <yasuri@charliesmp.net>
parents:
diff changeset
5
4034cee64a58 add stuff
Yasuri <yasuri@charliesmp.net>
parents:
diff changeset
6 It combines fastfetch and btop in one small program: a distro logo and
4034cee64a58 add stuff
Yasuri <yasuri@charliesmp.net>
parents:
diff changeset
7 system info that refresh every second, with live CPU, memory, and uptime.
4034cee64a58 add stuff
Yasuri <yasuri@charliesmp.net>
parents:
diff changeset
8
4034cee64a58 add stuff
Yasuri <yasuri@charliesmp.net>
parents:
diff changeset
9
4034cee64a58 add stuff
Yasuri <yasuri@charliesmp.net>
parents:
diff changeset
10 FEATURES
4034cee64a58 add stuff
Yasuri <yasuri@charliesmp.net>
parents:
diff changeset
11
4034cee64a58 add stuff
Yasuri <yasuri@charliesmp.net>
parents:
diff changeset
12 - Distro logo next to your system info (NixOS, Arch, Gentoo, plus a
4034cee64a58 add stuff
Yasuri <yasuri@charliesmp.net>
parents:
diff changeset
13 generic fallback)
4034cee64a58 add stuff
Yasuri <yasuri@charliesmp.net>
parents:
diff changeset
14 - Live-updating CPU usage, memory, and uptime
4034cee64a58 add stuff
Yasuri <yasuri@charliesmp.net>
parents:
diff changeset
15 - Picks the logo from /etc/os-release, and derivatives work through
4034cee64a58 add stuff
Yasuri <yasuri@charliesmp.net>
parents:
diff changeset
16 ID_LIKE (Manjaro gets the Arch logo, for example)
4034cee64a58 add stuff
Yasuri <yasuri@charliesmp.net>
parents:
diff changeset
17 - No dependencies beyond the C++ standard library
4034cee64a58 add stuff
Yasuri <yasuri@charliesmp.net>
parents:
diff changeset
18 - Reads /proc and /etc/os-release directly, so the code is short and
4034cee64a58 add stuff
Yasuri <yasuri@charliesmp.net>
parents:
diff changeset
19 easy to follow
4034cee64a58 add stuff
Yasuri <yasuri@charliesmp.net>
parents:
diff changeset
20
4034cee64a58 add stuff
Yasuri <yasuri@charliesmp.net>
parents:
diff changeset
21
4034cee64a58 add stuff
Yasuri <yasuri@charliesmp.net>
parents:
diff changeset
22 BUILD
4034cee64a58 add stuff
Yasuri <yasuri@charliesmp.net>
parents:
diff changeset
23
4034cee64a58 add stuff
Yasuri <yasuri@charliesmp.net>
parents:
diff changeset
24 g++ -std=c++17 main.cpp -o topfetch
4034cee64a58 add stuff
Yasuri <yasuri@charliesmp.net>
parents:
diff changeset
25
4034cee64a58 add stuff
Yasuri <yasuri@charliesmp.net>
parents:
diff changeset
26
4034cee64a58 add stuff
Yasuri <yasuri@charliesmp.net>
parents:
diff changeset
27 USAGE
4034cee64a58 add stuff
Yasuri <yasuri@charliesmp.net>
parents:
diff changeset
28
4034cee64a58 add stuff
Yasuri <yasuri@charliesmp.net>
parents:
diff changeset
29 ./topfetch
4034cee64a58 add stuff
Yasuri <yasuri@charliesmp.net>
parents:
diff changeset
30 ./topfetch --logo arch
4034cee64a58 add stuff
Yasuri <yasuri@charliesmp.net>
parents:
diff changeset
31
4034cee64a58 add stuff
Yasuri <yasuri@charliesmp.net>
parents:
diff changeset
32 --logo overrides the detected distro. Available logos: nixos, arch,
4034cee64a58 add stuff
Yasuri <yasuri@charliesmp.net>
parents:
diff changeset
33 gentoo. Unknown distros get a generic Tux. Stop it with Ctrl+C.
4034cee64a58 add stuff
Yasuri <yasuri@charliesmp.net>
parents:
diff changeset
34
4034cee64a58 add stuff
Yasuri <yasuri@charliesmp.net>
parents:
diff changeset
35
4034cee64a58 add stuff
Yasuri <yasuri@charliesmp.net>
parents:
diff changeset
36 PLATFORM
4034cee64a58 add stuff
Yasuri <yasuri@charliesmp.net>
parents:
diff changeset
37
4034cee64a58 add stuff
Yasuri <yasuri@charliesmp.net>
parents:
diff changeset
38 Linux only. It relies on /proc and /etc/os-release.
4034cee64a58 add stuff
Yasuri <yasuri@charliesmp.net>
parents:
diff changeset
39
4034cee64a58 add stuff
Yasuri <yasuri@charliesmp.net>
parents:
diff changeset
40
4034cee64a58 add stuff
Yasuri <yasuri@charliesmp.net>
parents:
diff changeset
41 ADDING A LOGO
4034cee64a58 add stuff
Yasuri <yasuri@charliesmp.net>
parents:
diff changeset
42
4034cee64a58 add stuff
Yasuri <yasuri@charliesmp.net>
parents:
diff changeset
43 Add an entry to the map in pickLogo in main.cpp. The key is the ID=
4034cee64a58 add stuff
Yasuri <yasuri@charliesmp.net>
parents:
diff changeset
44 value from /etc/os-release. Each entry holds the art lines and an ANSI
4034cee64a58 add stuff
Yasuri <yasuri@charliesmp.net>
parents:
diff changeset
45 color code.
4034cee64a58 add stuff
Yasuri <yasuri@charliesmp.net>
parents:
diff changeset
46
4034cee64a58 add stuff
Yasuri <yasuri@charliesmp.net>
parents:
diff changeset
47
4034cee64a58 add stuff
Yasuri <yasuri@charliesmp.net>
parents:
diff changeset
48 SOURCE
4034cee64a58 add stuff
Yasuri <yasuri@charliesmp.net>
parents:
diff changeset
49
4034cee64a58 add stuff
Yasuri <yasuri@charliesmp.net>
parents:
diff changeset
50 Development happens in Mercurial at https://hg.charliesmp.net/topfetch++.
4034cee64a58 add stuff
Yasuri <yasuri@charliesmp.net>
parents:
diff changeset
51 Send patches to Yasuri <yasuri@charliesmp.net>.
4034cee64a58 add stuff
Yasuri <yasuri@charliesmp.net>
parents:
diff changeset
52 This repository is a mirror.
4034cee64a58 add stuff
Yasuri <yasuri@charliesmp.net>
parents:
diff changeset
53
4034cee64a58 add stuff
Yasuri <yasuri@charliesmp.net>
parents:
diff changeset
54
4034cee64a58 add stuff
Yasuri <yasuri@charliesmp.net>
parents:
diff changeset
55 LICENSE
4034cee64a58 add stuff
Yasuri <yasuri@charliesmp.net>
parents:
diff changeset
56
4034cee64a58 add stuff
Yasuri <yasuri@charliesmp.net>
parents:
diff changeset
57 topfetch++ is licensed under the ISC license. See the LICENSE file.
4034cee64a58 add stuff
Yasuri <yasuri@charliesmp.net>
parents:
diff changeset
58
4034cee64a58 add stuff
Yasuri <yasuri@charliesmp.net>
parents:
diff changeset
59 The ASCII art logos are adapted from pfetch (MIT):
4034cee64a58 add stuff
Yasuri <yasuri@charliesmp.net>
parents:
diff changeset
60 Copyright (c) 2016-2021 Dylan Araps
4034cee64a58 add stuff
Yasuri <yasuri@charliesmp.net>
parents:
diff changeset
61 Copyright (c) 2024-2025 Joey Reinhart
4034cee64a58 add stuff
Yasuri <yasuri@charliesmp.net>
parents:
diff changeset
62 See the THIRD-PARTY-NOTICES file for the full license text.