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 7c6a610b 2020-10-01 op OpenBSD' `lex` and `yacc` were tested, as well as `bison` 3.3.2, GNU
17 7c6a610b 2020-10-01 op gcc 4.2.1 and 8.4.0, and clang 10.0.1
18 7c6a610b 2020-10-01 op 
19 e573cb09 2020-09-27 op Configuration for the build process can be found in `config.mk`, but
20 e573cb09 2020-09-27 op you usually don't need to modify it: passing the variables to make
21 e573cb09 2020-09-27 op should be enough.  For instance, to build with `gcc`
22 e573cb09 2020-09-27 op 
23 e573cb09 2020-09-27 op     make CC=gcc
24 e573cb09 2020-09-27 op 
25 7c6a610b 2020-10-01 op `bison` can be used instead of `yacc` by changing the `YACC` variable
26 e573cb09 2020-09-27 op 
27 7c6a610b 2020-10-01 op     make YACC=bison
28 e573cb09 2020-09-27 op 
29 7c6a610b 2020-10-01 op Unless you are compiling on OpenBSD, you probably want to change the
30 7c6a610b 2020-10-01 op default `CFLAGS` and `LDFLAGS`.
31 e573cb09 2020-09-27 op 
32 7c6a610b 2020-10-01 op If `etags` is available, a `TAGS` file is created.  Note however that
33 7c6a610b 2020-10-01 op `etags` is **not needed** for building: it's only a support tool used
34 7c6a610b 2020-10-01 op to aid the development.
35 7c6a610b 2020-10-01 op 
36 7c6a610b 2020-10-01 op ## FAQ
37 7c6a610b 2020-10-01 op 
38 e573cb09 2020-09-27 op  - the name is a jojo reference?
39 e573cb09 2020-09-27 op 
40 e573cb09 2020-09-27 op    Sort of.  I was listening to 「sono chi kioku」, the fourth opening,
41 e573cb09 2020-09-27 op    while I was playing with the idea of translating the key.  Given
42 e573cb09 2020-09-27 op    that I'm generally bad at naming things...