Skip to content

Commit 44eadc7

Browse files
committed
refactor: nits before release
1 parent 9e652e2 commit 44eadc7

File tree

2 files changed

+67
-51
lines changed

2 files changed

+67
-51
lines changed

README.md

Lines changed: 49 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,11 @@ Color scheme with clearly defined contrasting colors and a slightly earthy tone.
77
## Requirements
88

99
### GUI
10-
You don’t need to do anything for this colorscheme to work in GVim or MacVim.
10+
11+
You don’t need to do anything for this colorscheme to work in gVim or MacVim.
1112

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

5557
### Manually
58+
5659
Put `srcery.vim` in `~/.vim/colors/` (on unix-like systems) or `%userprofile%\vimfiles\colors\` (on Windows).
5760

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

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

65-
The same works for NeoVim, but you have to clone it into a path where NeoVim can
68+
The same works for Neovim, but you have to clone it into a path where Neovim can
6669
find it.
6770

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

7073
### [dein.vim](https://github.com/Shougo/dein.vim)
74+
7175
```vim
7276
call dein#add('srcery-colors/srcery-vim')
7377
```
7478

7579
### [vim-pathogen](https://github.com/tpope/vim-pathogen)
80+
7681
```shell
7782
cd ~/.vim/bundle
7883
git clone https://github.com/srcery-colors/srcery-vim
7984
```
8085

8186
### [vim-plug](https://github.com/junegunn/vim-plug)
87+
8288
```vim
8389
Plug 'srcery-colors/srcery-vim'
8490
```
8591

92+
## Usage
93+
94+
```
95+
:color srcery
96+
```
97+
98+
If you like what you see and decide to make srcery your default colorscheme, add the relevant line to your `.vimrc`:
99+
100+
```vim
101+
colorscheme srcery
102+
```
103+
86104
## Configuration
87105

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

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

97-
#### Colors
115+
### Colors
98116

99117
You can customize each of Srcery's colors, to customize say the red color:
118+
100119
```vim
101120
let g:srcery_red = '#FF0000'
102121
```
103122

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

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

129+
### Options
110130

111131
#### g:srcery_bold
112132

113133
Enables bold text.
114-
default: 1
134+
135+
Default: 1
115136

116137
#### g:srcery_italic
117138

118139
Enables italic text.
119-
default: gui 1, term 0
140+
141+
Default: gui 1, term 0
120142

121143
#### g:srcery_underline
122144

123145
Enables underlined text.
124-
default: 1
146+
147+
Default: 1
125148

126149
#### g:srcery_undercurl
127150

128151
Enables undercurled text.
129-
default: 1
152+
153+
Default: 1
130154

131155
#### g:srcery_inverse
132156

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

140-
default: 1
164+
Default: 1
141165

142166
#### g:srcery_inverse_matches
143167

144-
Highlight search matches using inverse colors
168+
Highlight search matches using inverse colors.
145169

146-
default: 0
170+
Default: 0
147171

148172
#### g:srcery_inverse_match_paren
149173

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

153-
Works best with [Rainbow parenthesis](https://github.com/kien/rainbow_parentheses.vim)
177+
Works best with [Rainbow parenthesis](https://github.com/kien/rainbow_parentheses.vim).
154178

155-
default: 0
179+
Default: 0
156180

157181
#### g:srcery_dim_lisp_paren
158182

159-
Dims lisp dialects delimiters to a fairly dark gray (xgray5 specifically)
183+
Dims lisp dialects delimiters to a fairly dark gray (xgray5 specifically).
160184

161-
default: 0
185+
Default: 0
162186

163187
#### g:srcery_bg_passthrough
164188

165-
Lets the terminal control the background color in Vim, setting the background
166-
in vim to NONE.
189+
Lets the terminal control the background color in Vim by setting the background to `NONE`.
167190

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

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

174-
default: 0
197+
Default: 0
175198

176199
#### g:srcery_guisp_fallback
177200

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

185-
default: 'NONE'
208+
Default: 'NONE'
186209

187-
possible Values: 'fg', 'bg'
210+
Possible Values: 'fg', 'bg'
188211

189212
#### g:srcery_italic_types
190213

191-
Italicize types if italic is enabled
192-
193-
default: 0
214+
Italicize types if italic is enabled.
194215

216+
Default: 0
195217

196-
## Usage
197-
```
198-
:color srcery
199-
```
200-
201-
If you like what you see and decide to make srcery your default colorscheme, add the relevant line to your vimrc:
202-
```vim
203-
colorscheme srcery
204-
```
205218
## Screenshots
219+
206220
viml, bash
207221
![viml_bash](https://raw.githubusercontent.com/srcery-colors/srcery-assets/master/vim/viml_bash.png)
208222

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

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

224237
## Plugin support
225238

226239
### Lightline
240+
227241
![lightline](https://raw.githubusercontent.com/srcery-colors/srcery-assets/master/vim/lightline.png)
228242

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

238252
### Airline
253+
239254
![airline](https://raw.githubusercontent.com/srcery-colors/srcery-assets/master/vim/airline.png)
240255

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

279294
Ensure that 256 colors are enabled in vim by setting this option **before** setting the colorscheme.
295+
280296
```viml
281297
set t_Co=256
282298
```

doc/srcery.txt

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,14 @@ License: MIT license
88

99
CONTENTS *srcery-contents*
1010

11-
Introduction |srcery-introduction|
12-
Installation |srcery-installation|
13-
Vim 8 |srcery-install-vim8|
14-
Dein |srcery-install-dein|
15-
Pathogen |srcery-install-pathogen|
16-
Plug |srcery-install-plug|
17-
Color table |srcery-color-table|
18-
Options |srcery-options|
11+
Introduction |srcery-introduction|
12+
Installation |srcery-installation|
13+
Vim 8 |srcery-install-vim8|
14+
Dein |srcery-install-dein|
15+
Pathogen |srcery-install-pathogen|
16+
Plug |srcery-install-plug|
17+
Color Table |srcery-color-table|
18+
Options |srcery-options|
1919
g:srcery_[color] |srcery-option-color|
2020
g:srcery_bold |srcery-option-bold|
2121
g:srcery_italic |srcery-option-italic|
@@ -52,7 +52,7 @@ clone this repository into `~/.vim/plug/default/opt`.
5252
~/.vim/plug/default/opt
5353
<
5454

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

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

122122
>
123123
let g:srcery_italic = 1
@@ -168,7 +168,7 @@ g:srcery_inverse
168168
Enable or disable inverse highlighting (foreground becomes background,
169169
vice versa). This is used for visual selection, search highlights and
170170
some other things.
171-
171+
172172
Srcery will fall back to other methods of highlighting if this is
173173
disabled.
174174

@@ -202,8 +202,8 @@ g:srcery_dim_lisp_paren
202202
*srcery-option-bg-passthrough*
203203
g:srcery_bg_passthrough
204204

205-
Lets the terminal control the background color in Vim, setting the
206-
background in vim to NONE.
205+
Lets the terminal control the background color in Vim by setting the
206+
background NONE.
207207

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

225-
default: `NONE`
225+
Default: `NONE`
226226

227-
possible Values: `fg`, `bg`
227+
Possible Values: `fg`, `bg`
228228

229229
*srcery-option-italic-types*
230230
g:srcery_italic_types
231231

232-
Italicize types if italic is enabled
233-
234-
default: 0
232+
Italicize types if italic is enabled.
233+
234+
Default: 0
235235

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

0 commit comments

Comments
 (0)