Skip to content

Commit 6a08455

Browse files
committed
Doc: add/update info about templating
1 parent e4a5cec commit 6a08455

File tree

2 files changed

+20
-8
lines changed

2 files changed

+20
-8
lines changed

Diff for: manual-installation.md

+16-4
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ Guidelines for creating a selenized theme for your terminal emulator.
55

66
Each Selenized variant defines 3 background shades (`bg_*`), 3 content shades
77
(`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).
8+
document explains which color to use for what. You can find [RGB values of the
9+
colors **here**](the-values.md).
1010

1111

1212
### Color mapping
@@ -56,8 +56,20 @@ ANSI palette:
5656
| 14 | bright cyan | br_cyan |
5757
| 15 | bright white | fg_1 |
5858

59+
60+
### Creating a template
61+
62+
Theme files should be generated from templates (so that it's easy to create
63+
configs for all selenized variants, and update them whenever colors change).
64+
65+
See
66+
[`utils/templates/template-test.example.template`](./utils/templates/template-test.example.template)
67+
for an example template and [`utils/README.md`](./utils/README.md) for
68+
instructions on how to use templating machinery.
69+
5970
That's it!
6071

6172
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 :-)
73+
with the resulting configs and template so that I can make your terminal
74+
officially supported :-)
75+

Diff for: utils/README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ templates.
99
### Requirements
1010

1111
- [Python](https://www.python.org/) with development files. Python 3.7
12-
and 2.7 is known works; 3.5 and 3.6 might work, but nobody tried yet,
12+
and 2.7 is known to work; 3.5 and 3.6 might work, but nobody tried yet.
1313
- [Colormath](https://github.com/gtaylor/python-colormath) Python library.
1414

1515
Example requirements installation for Debian/Ubuntu Linux and Python 2.7:
@@ -27,13 +27,13 @@ Example requirements installation for Debian/Ubuntu Linux and Python 2.7:
2727
To generate config file, use `evaluate_template.py` script. You need to provide
2828
it with two arguments: path to the palette module (with the palette you want to
2929
use) and path to a template config for your terminal. For example, if you
30-
wanted to generate selenized medium config file for iTerm, you would do it like
30+
wanted to generate selenized dark config file for iTerm, you would do it like
3131
this:
3232

3333
selenized/utils$ python evaluate_template.py \
34-
palettes/selenized_medium.py \
34+
palettes/selenized_dark.py \
3535
templates/itermcolors.template
36-
[...]
36+
3737
Processing templates/itermcolors.template...
3838
Result written to output/Selenized medium.itermcolors
3939

0 commit comments

Comments
 (0)