Skip to content

Commit

Permalink
Updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
noccy80 committed Dec 16, 2016
1 parent 31776c6 commit cf73737
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand All @@ -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`:
Expand Down

0 comments on commit cf73737

Please sign in to comment.