From c832a9341aaa78c79648a1e22b66f1dc1da2b1fe Mon Sep 17 00:00:00 2001 From: Guangyang Wen Date: Mon, 4 Dec 2017 23:30:48 +0100 Subject: [PATCH] Update README --- README.md | 46 +++++++++++++++++++++++++++++++++------------- 1 file changed, 33 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index fcd6608..2a46944 100644 --- a/README.md +++ b/README.md @@ -14,11 +14,15 @@ _Sègǎnchà_: A saying in Chinese depicting those who struggle to distinguish s Light themes generated with `--background 95` and `--temperature 4500`, `5000` and `5300` - +

+ +

Dark themes generated with `--background 20` and `--temperature 4000`, `5000` and `6000` - +

+ +

## Installation and Basic Usage @@ -32,22 +36,14 @@ Generate demo page ```shell segancha # generate ./segancha-default/ -cd ./segancha-default/demo/ +cd segancha-default/demo/ ``` -Generate warm & dark theme extension for VSCode +Generate warm & dark theme extension for VSCode and install it ```shell segancha --name my-warm-night --temperature 4500 --profile vscode -rsync -a ./segancha-my-warm-night/vscode/ ~/.vscode/extensions/ -``` - -Generate theme with reduced saturation for Neovim and VSCode - -```shell -segancha --name my-dumb-theme --maxC 20 --profile vim --profile vscode -rsync -a ./segancha-my-dumb-theme/vim/ ~/.config/nvim/colors/ -rsync -a ./segancha-my-dumb-theme/vscode/ ~/.vscode/extensions/ +rsync -a segancha-my-warm-night/vscode/ ~/.vscode/extensions/ ``` ## Command Line Arguments @@ -89,6 +85,30 @@ rsync -a ./segancha-my-dumb-theme/vscode/ ~/.vscode/extensions/ __Default__: `default` +## More Examples + +Generate default theme for Vim, Neovim and VSCode + +```shell +segancha --profile vim --profile vscode +rsync -a segancha-default/vim/ ~/.vim/colors/ +rsync -a segancha-default/vim/ ~/.config/nvim/colors/ +rsync -a segancha-default/vscode/ ~/.vscode/extensions/ +``` + +Generate theme with reduced saturation + +```shell +segancha --name my-dumb-theme --maxC 20 --profile vscode +``` + +Generate the color palette and apply it to your own theme template + +```shell +segancha --profile demo +pystache my-vim-theme.vim.mustache segancha-default/demo/context.json > my-vim-theme.vim +``` + ## Implementation Details TODO