#+title: Pumo System Info
#+author: Lucien “Phundrak” Cartier-Tilet
#+email: lucien@phundrak.com

* Introduction
~pumo-system-info~ is a cli utility designed to output in the terminal
system information. This includes:
- the OS’ name
- the OS’ kernel version
- the system’s name
- the current uptime
- the system’s current RAM usage
- the system’s current swap usage
- the system’s current partition usage

** What does “Pumo” mean?
It’s my cat’s name.

* Build the project

** From ~cargo~
You can build the project by running the following command:
#+begin_src sh
cargo build --release
#+end_src

If you want to directly run it, you can instead execute the following
command:
#+begin_src sh
cargo run --release
#+end_src

If you want, you can also skip all these steps and install it in
~$HOME/.cargo/bin~ with the following command:
#+begin_src sh
cargo install --path .
#+end_src

Ensure ~$HOME/.cargo/bin~ is in your ~$PATH~, then simply run
~pumo-system-info~.

** ArchLinux
A PKGBUILD is made available in the [[file:./archlinux]] directory so you
can install ~pumo-system-info~ as a native Arch package. To use it, run
the following commands:
#+begin_src sh
cd archlinux/
makepkg -si
#+end_src

* License
~pumo-system-info~ is under the GPL-3.0 license. You can either read [[https://tldrlegal.com/license/gnu-lesser-general-public-license-v3-(lgpl-3)][a
tl;dr of the license]] or [[file:LICENSE][the full legal text]].