diff --git a/README.md b/README.md new file mode 100644 index 0000000..621b147 --- /dev/null +++ b/README.md @@ -0,0 +1,64 @@ +Solid — A Liquid Prompt Theme +============================= + +Solid is a didactic theme for [Liquid Prompt](https://github.com/nojhan/liquidprompt). + +Its aim is not to actually be used as a day-to-day prompt (but you do you), +but to expose everything that Liquid Prompt actually watches. +It thus shows a table with the full state of the system, as seen by Liquid Prompt. + + +Preview +------- + +![image](solid-demo.png) + + +Rationale +--------- + +The `solid` theme displays (almost) all the information that Liquid Prompt can display. +All variables are always displayed at the very same location, so that you may always see their state. +That way, you can explore and understand how Liquid Prompt actually react to your system's state, +which may be especially useful if you are a theme designer. + +### Explanations + +Each element of the table is a label, followed by a colon and a field. +The field can be either a boolean flag ("◌"=false, "●"=true), or a fixed-size entry (between squared brackets). + +Entries can show numbers (always right-aligned), texts or be filled by a "/" character. +This last state indicates that the configuration is explicitely asking for the field to not be displayed +(i.e. the `LP_ENABLE_*` variable is set to 0). + +If the field is shown in the base color (violet, by default), +it would normally not be displayed in the Liquid Prompt's *default* theme; +else, it is displayed in green. +If the field content is important or indicates a potentially dangerous state, +it is displayed in yellow. + + +Install +------- + +Just download this repository somewhere, source the theme file and activate the theme from your shell configuration file. + +For example (just use `~/.zshrc` instead of `~/.bashrc`, if you use Zsh and not Bash): +```sh +git clone https://github.com/nojhan/lp-neon.git +echo '# Use Liquid Prompt only if in an interactive shell + if [[ $- == *i* ]]; then + # Use Liquid Prompt + source ~/.liquidprompt + # Use the solid theme if it has been downloaded in ~. + if [[ -f ~/lp-solid/solid.theme ]] ; then + source ~/lp-solid/solid.theme && lp_theme solid + fi + fi' >> ~/.bashrc +``` + + +Configuration +------------- + +TODO diff --git a/solid-demo.png b/solid-demo.png new file mode 100644 index 0000000..9ad3815 Binary files /dev/null and b/solid-demo.png differ