Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
gywn authored Nov 30, 2017
1 parent 60af169 commit 44d53cb
Showing 1 changed file with 20 additions and 6 deletions.
26 changes: 20 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
# Segancha

[![PyPI version](https://badge.fury.io/py/segancha.svg)](https://badge.fury.io/py/segancha)
[![GitHub version](https://badge.fury.io/gh/gywn%2Fsegancha.svg)](https://badge.fury.io/gh/gywn%2Fsegancha)

A Python3 library with CLI that generates the optimal discernible color palette for theme building.

_Sègǎnchà_: A word of Chinese depicting those who struggle to distinguish small nuance between colors.
_Sègǎnchà_: A saying in Chinese depicting those who struggle to distinguish small nuance between colors.

## Screenshots

Expand All @@ -14,21 +17,32 @@ Dark themes `--background 20` with `--temperature 4000`, `5000` and `6000`

<img src="https://raw.githubusercontent.com/gywn/segancha/images/images/thumb-bg20-T4000.svg?sanitize=true" width="276" /> <img src="https://raw.githubusercontent.com/gywn/segancha/images/images/thumb-bg20-T5000.svg?sanitize=true" width="276" /> <img src="https://raw.githubusercontent.com/gywn/segancha/images/images/thumb-bg20-T6000.svg?sanitize=true" width="276" />

## Installation and Usage
## Installation and Basic Usage

Install from PyPI

pip3 install segancha

Generate demo page

segancha --profile demo
segancha
cd ./segancha-default/demo/

Generate warm & dark theme extension for VSCode

segancha --name warm-and-dark --temperature 4500 --background 15 --profile vscode
rsync -a ./segancha-warm-and-dark/vscode/ ~/.vscode/extensions/
segancha --name my-warm-night --temperature 4500 --background 15 --profile vscode
rsync -a ./segancha-my-warm-night/vscode/ ~/.vscode/extensions/

Generate theme with reduced saturation for Neovim and VSCode

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/

## Command Line Arguments
TODO

## Implementation
## Implementation Details
TODO

## Aknowladgement
Expand Down

0 comments on commit 44d53cb

Please sign in to comment.