From cf73737ab34e5890af608b846ef9c7928d563fe4 Mon Sep 17 00:00:00 2001 From: Christopher Vagnetoft Date: Fri, 16 Dec 2016 02:09:13 +0100 Subject: [PATCH] Updated readme --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/README.md b/README.md index 600f04a..3b052d0 100644 --- a/README.md +++ b/README.md @@ -37,11 +37,20 @@ To make the prompt less fluffy, you can create a compact style. Create `~/.power pad-before: 0; pad-after: 0; } + status path { + pad-before: 1; + } Activate the theme using `phpl-config`: $ phpl-config --theme compact +The prompt will now look like: + + user@hostname ~ $ + +### Colors and stuff + To add some color to the prompt: username hostname { @@ -64,6 +73,20 @@ This will have the following result: * The status indicator (`$`) will be colored green if the last command was successful, and red otherwise. +### Class vs. Status + +Some modules will signal a status, usually `good` or `bad`. This status can be used for theming, +by prefixing it with a colon (`:`): + + diskfree:bad <-- when you are low on space + :good <-- everything that is good + +Some modules let you pick a class using options, others will use a fixed class. Some common are: + + * `.system` - Information about the system, disk, ram, cpu etc. + * `.user` - Information about the user, name, etc. + * `.info` - Generic information such as time, text etc. + ## More commands You can list all the available modules using `phpl-config -L`: