docs: update readme

This commit is contained in:
Lucien Cartier-Tilet 2025-06-03 22:14:57 +02:00
parent 06fa652f96
commit 235863cd9e
Signed by: phundrak
SSH Key Fingerprint: SHA256:CE0HPsbW3L2YiJETx1zYZ2muMptaAqTN2g3498KrMkc

View File

@ -19,7 +19,7 @@ be used with my [[https://elkowar.github.io/eww/][eww]] configuration.
- Nix package manager with flakes (optional, for building and managing - Nix package manager with flakes (optional, for building and managing
dependencies) dependencies)
* Installation * Build and Run =pumo-system-info=
1. Clone the repository 1. Clone the repository
#+begin_src sh #+begin_src sh
@ -41,6 +41,30 @@ cargo build --release
./target/release/pumo-system-info ./target/release/pumo-system-info
#+end_src #+end_src
* Installation
** With Cargo
You can install =pumo-system-info= using the following command:
#+begin_src sh
cargo install --path .
#+end_src
** Flake Input
You can add this repository in your flake inputs like so:
#+begin_src nix
inputs.pumo-system-info.url = "git+https://labs.phundrak.com/phundrak/pumo-system-info";
#+end_src
You can also make it follow your =nixpkgs= version with this:
#+begin_src nix
pumo-system-info = {
url = "git+https://labs.phundrak.com/phundrak/pumo-system-info";
inputs.nixpkgs.follows = "nixpkgs";
};
#+end_src
You can now install =inputs.pumo-system-info.packages.${system}.default=
as a package. =${system}= can be either =x86_64-linux= or =aarch64-linux=.
* Performance * Performance
Since this is a utility for bringing information to eww, this project Since this is a utility for bringing information to eww, this project
needs to run fast. Fortunately, it does! Here are some benchmarks I needs to run fast. Fortunately, it does! Here are some benchmarks I