Skip to content

Commit 660a25f

Browse files
committed
Doc: add manual installation instructions
1 parent 237fa78 commit 660a25f

File tree

4 files changed

+65
-20
lines changed

4 files changed

+65
-20
lines changed

CONTRIBUTING.md

-12
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,3 @@
1-
Where are orange and violet?
2-
----------------------------
3-
4-
Selenized [defines](the-values.md) 8 accent colors: red, orange, yellow, green,
5-
cyan, blue, violet and magenta. However, terminal emulators traditionally have
6-
escape codes for 6 colors (red, yellow, green, cyan, blue and magenta), with
7-
two additional codes for black and white. Therefore, terminal configs included
8-
in this repository don't include orange and violet. However, configs for GUI
9-
programs will include the full palette (as GUI programs can define as many
10-
colors as they want).
11-
12-
131
Syntax highlighting design principles
142
-------------------------------------
153

README.md

+2-4
Original file line numberDiff line numberDiff line change
@@ -66,10 +66,8 @@ please comment on
6666

6767
### Manual installation
6868

69-
If your application is not listed above, you can manually copy [hex
70-
values](the-values.md) into its preferences. Please consider sending me a pull
71-
request with the resulting configuration so that I can add it to officially
72-
supported terminals :-)
69+
If your application is not listed above, it's easy to set the colors manually.
70+
See [this document](manual-installation.md) for guidelines.
7371

7472

7573

manual-installation.md

+63
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
Using selenized palette
2+
-----------------------
3+
4+
Guidelines for creating a selenized theme for your terminal emulator.
5+
6+
Each Selenized variant defines 3 background shades (`bg_*`), 3 content shades
7+
(`dim_*`, `fg_*`) and 8 accent colors (each with a bright version). This
8+
document explains which color to use for what. You can find RGB values of the
9+
colors [here](the-values.md).
10+
11+
12+
### Color mapping
13+
14+
| Element | Color |
15+
| ----------------- | ------ |
16+
| background | bg_0 |
17+
| foreground | fg_0 |
18+
| bold foreground | fg_1 |
19+
| dim foreground | dim_0 |
20+
| cursor color | fg_1 |
21+
| selection | bg_2 |
22+
| selection text | (none) |
23+
24+
Notes:
25+
26+
* Most terminals don't allow setting selection colors, they simply reverse
27+
foreground and background.
28+
* Some terminals allow setting the opacity/brightness of special "dim" colors.
29+
This value should be set to 0.625.
30+
* In case your terminal has a setting like "bright background", set it to
31+
`bg_1`.
32+
* ANSI colors don't include orange and violet, so they are not used in terminal
33+
emulators - they are intended for GUI applications.
34+
35+
36+
37+
ANSI palette:
38+
39+
| # | ANSI color | Selenized color |
40+
| --- | -------------- | --------------- |
41+
| 0 | black | bg_1 |
42+
| 1 | red | red |
43+
| 2 | green | green |
44+
| 3 | yellow | yellow |
45+
| 4 | blue | blue |
46+
| 5 | magenta | magenta |
47+
| 6 | cyan | cyan |
48+
| 7 | white | dim_0 |
49+
| | | |
50+
| 8 | bright black | bg_2 |
51+
| 9 | bright red | br_red |
52+
| 10 | bright green | br_green |
53+
| 11 | bright yellow | br_yellow |
54+
| 12 | bright blue | br_blue |
55+
| 13 | bright magenta | br_magenta |
56+
| 14 | bright cyan | br_cyan |
57+
| 15 | bright white | fg_1 |
58+
59+
That's it!
60+
61+
Please send me a [pull request](https://github.com/jan-warchol/selenized/pulls)
62+
with the resulting configuration so that I can make your terminal officially
63+
supported :-)

the-values.md

-4
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,6 @@ LAB values are canonical. RGB values (both sRGB and Apple RGB) are calculated
55
from LAB using `utils/convert-lab-palette-to-rgbs.py` script, which employs
66
`python-colormath` library for color space transformations.
77

8-
Please note that orange and violet are not used in configs of terminal
9-
emulators - they are intended for use with GUI applications (see
10-
[FAQ](README.md#where-are-orange-and-violet)).
11-
128

139

1410
Selenized dark

0 commit comments

Comments
 (0)