From bcdbb680b9a4d644ffadce7a8359b736d49a6edb Mon Sep 17 00:00:00 2001 From: Andrew Janke Date: Sat, 21 Feb 2015 16:39:22 -0500 Subject: [PATCH] Add theme format description --- Themes.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/Themes.md b/Themes.md index eacd29c..9550359 100644 --- a/Themes.md +++ b/Themes.md @@ -1,10 +1,21 @@ All the current themes can be found in the `themes/` directory in the oh-my-zsh distribution. [See list here.](http://github.com/robbyrussell/oh-my-zsh/tree/master/themes/) -In order to enable a theme, set `ZSH_THEME` to the name of the theme in your `~/.zshrc`, before sourcing Oh My Zsh; _e.g._ `ZSH_THEME=robbyrussell` +In order to enable a theme, set `ZSH_THEME` to the name of the theme in your `~/.zshrc`, before sourcing Oh My Zsh; for example: `ZSH_THEME=robbyrussell` If you do not want any theme enabled, just set `ZSH_THEME` to blank: `ZSH_THEME=""` Here is a collection of screenshots and descriptions of themes that have been contributed to Oh My Zsh. There are some missing from this page. +#### Theme Description Format + +The theme descriptions should contain: +* The name of the theme. +* A screenshot. +* Instructions for any configuration besides setting `ZSH_THEME` in `~/.zshrc`. For example, font installation, terminal colorscheme configuration, or optional environment variables that affect the theme. +* Any dependencies outside Oh My Zsh. + +We use manually-constructed screenshots because some of the themes require additional terminal configuration to look their best, and so the code in example shell sessions can showcase the theme's features. There is also a separate collection of automatically-generated screenshots linked [at the bottom of this page](#screenshots-of-each-theme). + +## The Themes ### robbyrussell *the (default) that Robby uses*