Update README.md
[k_transpose.git] / README.md
1 # kremlin transpose
2 *top secret kremlin color transposition device*
3
4 transposes colors in web pages to match your ANSI terminal color theme.
5
6 k_transpose starts a local http server (localhost/kt/) through which you browse the outside web in the form e.g. http://localhost/kt/google.com. both relative & explicit URLs/URIs are prepended to route through this local http server such that one can browse the web "normally" after specifying the transposition server once
7
8 terminal colors are read from ~/.Xresources in the form 'URxvt\*color[0-16]:#RRGGBB' or '*color[0-16]:#RRGGBB'. *background: & *foreground: colors are used too, to determine light/dark theme context
9
10 ##colorspace transposition
11 TODO
12
13 ### compilation/installation
14 ```
15 make
16 sudo make install
17 ```
18
19 ### running
20 ```
21 # you likely need root to bind httpds to a local port
22 sudo k_transpose
23 ```