From dafacf8c71fd8edf630fb1d26e3e2d6d9224f526 Mon Sep 17 00:00:00 2001 From: Dylan Araps Date: Tue, 24 Sep 2019 14:50:14 +0300 Subject: [PATCH] docs: update --- README.md | 33 +++++++++++++++++++++++++++++++++ pfetch | 11 ++++++----- 2 files changed, 39 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 6dccc2f..1eca0e7 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,39 @@ _/\ __)/_) pkgs 130 \/-____\/ memory 1721MiB / 7942MiB ``` +## Configuration + +`pfetch` is configured through environment variables. + +```sh +# Which information to display. +# NOTE: If 'ascii' will be used, it must come first. +# Valid: space separated string +PF_INFO="ascii title distro host kernel uptime pkgs memory" + +# Example: Only ASCII. +PF_INFO="ascii" + +# Example: Only Information. +PF_INFO="title distro host kernel uptime pkgs memory" + +# Separator between info name and info data. +# Valid: string +PF_SEP=":" + +# Color of info names: +# Valid: 0-9 +PF_COL1=4 + +# Color of info data: +# Valid: 0-9 +PF_COL2=7 + +# Alignment padding. +# Valid: int +PF_ALIGN="" +``` + ## TODO - [x] Store ascii "width" for dynamic padding. diff --git a/pfetch b/pfetch index cd57574..fda2ca8 100755 --- a/pfetch +++ b/pfetch @@ -54,9 +54,10 @@ log() { # # $[6] /home/goldie $ # - # PF_COL1: Control color of info name. - # PF_SEP: Control the separator between info name and info data. - # PF_COL2: Control color of info data. + # PF_COL1: Control color of info name. + # PF_SEP: Control the separator between info name and info data. + # PF_COL2: Control color of info data. + # PF_ALIGN: Control the alignment amount. # # '\033[14C': Move cursor 14 characters to the right. # TODO: Base this on ASCII art width. @@ -75,10 +76,10 @@ log() { "${ascii_width:--1}" \ "${PF_COL1:-5}" \ "$1" \ - "${PF_SEP:- }" \ + "$PF_SEP" \ "${PF_COL2:-7}" \ "${#1}" \ - "${PF_ALIGN:-$info_length}" \ + "${PF_ALIGN:-$((info_length + 1))}" \ "$2" # Keep track of the number of times 'log()' has been run.