From af120ab348f2e1a5a39dec035ed9dcf84189a64e Mon Sep 17 00:00:00 2001 From: Biswakalyan Bhuyan Date: Mon, 3 Oct 2022 21:42:20 +0530 Subject: dotfiles --- zsh/oh-my-zsh/plugins/battery/README.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 zsh/oh-my-zsh/plugins/battery/README.md (limited to 'zsh/oh-my-zsh/plugins/battery/README.md') diff --git a/zsh/oh-my-zsh/plugins/battery/README.md b/zsh/oh-my-zsh/plugins/battery/README.md new file mode 100644 index 0000000..18e5bd8 --- /dev/null +++ b/zsh/oh-my-zsh/plugins/battery/README.md @@ -0,0 +1,29 @@ +# Battery Plugin + +This plugin adds some functions you can use to display battery information in your custom theme. + +To use, add `battery` to the list of plugins in your `.zshrc` file: + +`plugins=(... battery)` + +Then, add the `battery_pct_prompt` function to your custom theme. For example: + +```zsh +RPROMPT='$(battery_pct_prompt) ...' +``` + +## Requirements + +- On Linux, you must have the `acpi` or `acpitool` commands installed on your operating system. + On Debian/Ubuntu, you can do that with `sudo apt install acpi` or `sudo apt install acpitool`. + +- On Android (via [Termux](https://play.google.com/store/apps/details?id=com.termux)), you must have: + + 1. The `Termux:API` addon app installed: + [Google Play](https://play.google.com/store/apps/details?id=com.termux.api) | [F-Droid](https://f-droid.org/packages/com.termux.api/) + + 2. The `termux-api` package installed within termux: + + ```sh + pkg install termux-api + ``` -- cgit v1.2.3-59-g8ed1b