Blame


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