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 OpenBSD' `lex` and `yacc` were tested, as well as `bison` 3.3.2, GNU
17 gcc 4.2.1 and 8.4.0, and clang 10.0.1
18 
19 Configuration for the build process can be found in `config.mk`, but
20 you usually don't need to modify it: passing the variables to make
21 should be enough.  For instance, to build with `gcc`
22 
23     make CC=gcc
24 
25 `bison` can be used instead of `yacc` by changing the `YACC` variable
26 
27     make YACC=bison
28 
29 Unless you are compiling on OpenBSD, you probably want to change the
30 default `CFLAGS` and `LDFLAGS`.
31 
32 If `etags` is available, a `TAGS` file is created.  Note however that
33 `etags` is **not needed** for building: it's only a support tool used
34 to aid the development.
35 
36 ## FAQ
37 
38  - it does not seems to work!
39 
40    There’s currently a limitation, star-platinum won’t work with
41    reparenting window manager (such as the heavier DE, but also some
42    lighter WM like stumpwm or i3).
43 
44  - the name is a jojo reference?
45 
46    Sort of.  I was listening to 「sono chi kioku」, the fourth opening,
47    while I was playing with the idea of translating the key.  Given
48    that I'm generally bad at naming things...