stow/oh-my-zsh/.oh-my-zsh/plugins/battery/README.md

   1 # Battery Plugin
   2
   3 This plugin adds some functions you can use to display battery information in your custom theme.
   4
   5 To use, add `battery` to the list of plugins in your `.zshrc` file:
   6
   7 `plugins=(... battery)`
   8
   9 Then, add the `battery_pct_prompt` function to your custom theme. For example:
  10
  11 ```zsh
  12 RPROMPT='$(battery_pct_prompt) ...'
  13 ```
  14
  15 ## Requirements
  16
  17 - On Linux, you must have the `acpi` or `acpitool` commands installed on your operating system.
  18   On Debian/Ubuntu, you can do that with `sudo apt install acpi` or `sudo apt install acpitool`.
  19
  20 - On Android (via [Termux](https://play.google.com/store/apps/details?id=com.termux)), you must have:
  21
  22   1. The `Termux:API` addon app installed:
  23      [Google Play](https://play.google.com/store/apps/details?id=com.termux.api) | [F-Droid](https://f-droid.org/packages/com.termux.api/)
  24
  25   2. The `termux-api` package installed within termux:
  26
  27      ```sh
  28      pkg install termux-api
  29      ```