Skip to content

Commit

Permalink
refactor: nits before release
Browse files Browse the repository at this point in the history
  • Loading branch information
@MindTooth
MindTooth committed May 25, 2021
1 parent 9e652e2 commit 44eadc7
Show file tree
Hide file tree
Showing 2 changed files with 67 additions and 51 deletions.
82 changes: 49 additions & 33 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,11 @@ Color scheme with clearly defined contrasting colors and a slightly earthy tone.
## Requirements

### GUI
You don’t need to do anything for this colorscheme to work in GVim or MacVim.

You don’t need to do anything for this colorscheme to work in gVim or MacVim.

### TUI

To use Srcery in the terminal you need to change your terminal emulator’s
so-called “ASCII” colors to the ones in the table below. There's a list of
terminal configurations in the
Expand Down Expand Up @@ -53,6 +55,7 @@ to pad out the color selection, no extra configuration needed.
## Installation

### Manually

Put `srcery.vim` in `~/.vim/colors/` (on unix-like systems) or `%userprofile%\vimfiles\colors\` (on Windows).

### Vim 8
Expand All @@ -62,27 +65,42 @@ this repository into `~/.vim/plug/default/opt`.

git clone https://github.com/srcery-colors/srcery-vim ~/.vim/plug/default/opt

The same works for NeoVim, but you have to clone it into a path where NeoVim can
The same works for Neovim, but you have to clone it into a path where Neovim can
find it.

git clone https://github.com/srcery-colors/srcery-vim ~/.config/nvim/plug/default/opt

### [dein.vim](https://github.com/Shougo/dein.vim)

```vim
call dein#add('srcery-colors/srcery-vim')
```

### [vim-pathogen](https://github.com/tpope/vim-pathogen)

```shell
cd ~/.vim/bundle
git clone https://github.com/srcery-colors/srcery-vim
```

### [vim-plug](https://github.com/junegunn/vim-plug)

```vim
Plug 'srcery-colors/srcery-vim'
```

## Usage

```
:color srcery
```

If you like what you see and decide to make srcery your default colorscheme, add the relevant line to your `.vimrc`:

```vim
colorscheme srcery
```

## Configuration

Srcery includes a few toggles due to discrepancies in the various setups possible.
Expand All @@ -94,39 +112,45 @@ let g:srcery_italic = 1

Make sure that you set these variables before assigning `colorscheme`.

#### Colors
### Colors

You can customize each of Srcery's colors, to customize say the red color:

```vim
let g:srcery_red = '#FF0000'
```

Refer to the [table](#TUI) for a full list of color variables, hexes and more.

This will only work on `set termguicolors` and in Gvim, to override terminal
This will only work on `set termguicolors` and in gVim, to override terminal
colors, do so in your [terminal
configuration](https://github.com/srcery-colors/srcery-terminal).

### Options

#### g:srcery_bold

Enables bold text.
default: 1

Default: 1

#### g:srcery_italic

Enables italic text.
default: gui 1, term 0

Default: gui 1, term 0

#### g:srcery_underline

Enables underlined text.
default: 1

Default: 1

#### g:srcery_undercurl

Enables undercurled text.
default: 1

Default: 1

#### g:srcery_inverse

Expand All @@ -137,41 +161,40 @@ some other things.
Srcery will fall back to other methods of highlighting if this is
disabled.

default: 1
Default: 1

#### g:srcery_inverse_matches

Highlight search matches using inverse colors
Highlight search matches using inverse colors.

default: 0
Default: 0

#### g:srcery_inverse_match_paren

When enabled will highlight matching delimiters using inverse colors.
(`:DoMatchParen`)

Works best with [Rainbow parenthesis](https://github.com/kien/rainbow_parentheses.vim)
Works best with [Rainbow parenthesis](https://github.com/kien/rainbow_parentheses.vim).

default: 0
Default: 0

#### g:srcery_dim_lisp_paren

Dims lisp dialects delimiters to a fairly dark gray (xgray5 specifically)
Dims lisp dialects delimiters to a fairly dark gray (xgray5 specifically).

default: 0
Default: 0

#### g:srcery_bg_passthrough

Lets the terminal control the background color in Vim, setting the background
in vim to NONE.
Lets the terminal control the background color in Vim by setting the background to `NONE`.

A possible use case for this could be you want to manipulate the background
color in the terminal, and let the results bubble up to Vim, like [this](https://github.com/roosta/tmux-pop).

This is a bit of an experimental option, and can cause issues in certain
terminals.

default: 0
Default: 0

#### g:srcery_guisp_fallback

Expand All @@ -182,27 +205,18 @@ background or foreground to whatever color the underline is supposed to be.
This comes in handy if colored underline doesn't work, or underline is disabled
entirely.

default: 'NONE'
Default: 'NONE'

possible Values: 'fg', 'bg'
Possible Values: 'fg', 'bg'

#### g:srcery_italic_types

Italicize types if italic is enabled

default: 0
Italicize types if italic is enabled.

Default: 0

## Usage
```
:color srcery
```

If you like what you see and decide to make srcery your default colorscheme, add the relevant line to your vimrc:
```vim
colorscheme srcery
```
## Screenshots

viml, bash
![viml_bash](https://raw.githubusercontent.com/srcery-colors/srcery-assets/master/vim/viml_bash.png)

Expand All @@ -218,12 +232,12 @@ python, js
git, terminal
![git_term](https://raw.githubusercontent.com/srcery-colors/srcery-assets/master/vim/git_term.png)


Typeface used in screenshots is [Iosevka](https://github.com/be5invis/Iosevka)

## Plugin support

### Lightline

![lightline](https://raw.githubusercontent.com/srcery-colors/srcery-assets/master/vim/lightline.png)

[Lightline](https://github.com/itchyny/lightline.vim) colorscheme.
Expand All @@ -236,6 +250,7 @@ let g:lightline = {
```

### Airline

![airline](https://raw.githubusercontent.com/srcery-colors/srcery-assets/master/vim/airline.png)

Thanks to [MindTooth](https://github.com/MindTooth), Srcery now includes an [Airline](https://github.com/vim-airline/vim-airline) theme.
Expand Down Expand Up @@ -277,6 +292,7 @@ Srcery:
### Colors don't look right

Ensure that 256 colors are enabled in vim by setting this option **before** setting the colorscheme.

```viml
set t_Co=256
```
Expand Down
36 changes: 18 additions & 18 deletions doc/srcery.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@ License: MIT license

CONTENTS *srcery-contents*

Introduction |srcery-introduction|
Installation |srcery-installation|
Vim 8 |srcery-install-vim8|
Dein |srcery-install-dein|
Pathogen |srcery-install-pathogen|
Plug |srcery-install-plug|
Color table |srcery-color-table|
Options |srcery-options|
Introduction |srcery-introduction|
Installation |srcery-installation|
Vim 8 |srcery-install-vim8|
Dein |srcery-install-dein|
Pathogen |srcery-install-pathogen|
Plug |srcery-install-plug|
Color Table |srcery-color-table|
Options |srcery-options|
g:srcery_[color] |srcery-option-color|
g:srcery_bold |srcery-option-bold|
g:srcery_italic |srcery-option-italic|
Expand Down Expand Up @@ -52,7 +52,7 @@ clone this repository into `~/.vim/plug/default/opt`.
~/.vim/plug/default/opt
<

The same works for NeoVim, but you have to clone it into a path where NeoVim
The same works for Neovim, but you have to clone it into a path where Neovim
can find it.
>
git clone https://github.com/srcery-colors/srcery-vim \
Expand Down Expand Up @@ -117,7 +117,7 @@ no extra configuration needed.
OPTIONS *srcery-options*

Srcery includes a few toggles due to discrepancies in the various setups
possible. To change any of these you’d put something like this in your .vimrc
possible. To change any of these you’d put something like this in your .vimrc:

>
let g:srcery_italic = 1
Expand Down Expand Up @@ -168,7 +168,7 @@ g:srcery_inverse
Enable or disable inverse highlighting (foreground becomes background,
vice versa). This is used for visual selection, search highlights and
some other things.

Srcery will fall back to other methods of highlighting if this is
disabled.

Expand Down Expand Up @@ -202,8 +202,8 @@ g:srcery_dim_lisp_paren
*srcery-option-bg-passthrough*
g:srcery_bg_passthrough

Lets the terminal control the background color in Vim, setting the
background in vim to NONE.
Lets the terminal control the background color in Vim by setting the
background NONE.

A possible use case for this could be you want to manipulate the
background color in the terminal, and let the results bubble up to
Expand All @@ -222,16 +222,16 @@ g:srcery_guisp_fallback
This comes in handy if colored underline doesn’t work, or underline is
disabled entirely.

default: `NONE`
Default: `NONE`

possible Values: `fg`, `bg`
Possible Values: `fg`, `bg`

*srcery-option-italic-types*
g:srcery_italic_types

Italicize types if italic is enabled
default: 0
Italicize types if italic is enabled.

Default: 0

==============================================================================
vim: tw=78:ts=8:ft=help:norl:noet:fen:noet :

0 comments on commit 44eadc7

Please sign in to comment.