-
Notifications
You must be signed in to change notification settings - Fork 424
Theme sharing
While a working Liquidprompt theme is a working theme, adding a few details will make other users more likely to notice your theme.
Add a README to the theme, containing these sections:
Add screenshots previewing the theme under different conditions. Use the theme-preview.sh script to generate standard prompts that you can screenshot. If you use this script, you can use this template for the images:
If there is nothing special about the current context, the appearance of Liquidprompt is similar to that of a default prompt:
[image-short]
If you are running a background command and are also in the "main" branch of a Git repository on a server:
[image-med]
When Liquidprompt is displaying nearly everything, it may look like this:
[image-long]
If the theme needs any setup outside sourcing the theme file and running lp_theme <theme_id>, detail what needs to be done here.
Explain the configuration options, first:
List what Liquidprompt configuration options the theme supports, or if it supports almost all of them, what options it does not support.
The more options the theme supports, the more likely users are to try it. Try to build the theme to support all of the data functions Liquidprompt provides.
Detail the configuration options for the theme. List the defaults and what types it supports (int, string, array).
List the versions of Liquidprompt the theme supports. Be explicit, do not just say "all" or "current".
To help users find your theme, you can add it to the Theme List wiki page. See that page for details on how to do that.