1 # star platinum
2 
3 `star-platinum` is a key binding manager for x11.  It acts primarily
4 as a translator: the canonical example is to Emacs-ify various
5 programs by customizing how some key are handled.
6 
7 Check out the [manpage](star-platinum.1) for more information.
8 
9 ## Building
10 
11 `star-platinum` depends on `xlib` and needs a C compiler, `yacc` and
12 `lex` to compile.  With that in place, it's as easy as
13 
14     make
15 
16 Configuration for the build process can be found in `config.mk`, but
17 you usually don't need to modify it: passing the variables to make
18 should be enough.  For instance, to build with `gcc`
19 
20     make CC=gcc
21 
22 ## FAQ
23 
24  - *something something* bison *something something*
25 
26    `star-platinum` should build with GNU `bison` and flex, but I've
27    still not tried.  `bison` has some defaults different from `yacc`
28    IIRC, so additional flags may be needed.
29 
30  - the name is a jojo reference?
31 
32    Sort of.  I was listening to 「sono chi kioku」, the fourth opening,
33    while I was playing with the idea of translating the key.  Given
34    that I'm generally bad at naming things...