diff --git a/README.org b/README.org index d2641bd..cb86ea5 100644 --- a/README.org +++ b/README.org @@ -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 dependencies) -* Installation +* Build and Run =pumo-system-info= 1. Clone the repository #+begin_src sh @@ -41,6 +41,30 @@ cargo build --release ./target/release/pumo-system-info #+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 Since this is a utility for bringing information to eww, this project needs to run fast. Fortunately, it does! Here are some benchmarks I