updated README
[k8sterm.git] / README
blob3712d63295272a0401cf1c84a115bad1847b6b6c
1 WARNING! WARNING! WARNING!
2 --------------------------
3 This project is finished and closed. DO NOT USE IT.
5 It's successor is YTERM: https://repo.or.cz/yterm.git
7 YTERM is smaller, faster, better, and more correct.
11 sterm - simple terminal
12 -----------------------
13 sterm is a simple virtual terminal emulator for X which sucks less.
16 Requirements
17 ------------
18 In order to build sterm you need the Xlib header files.
21 Compiling
22 ---------
23 Download, build and install latest K8Jam from http://repo.or.cz/w/k8jam.git
25 * On Mac OS X, install pkg-config by executing
26 * sudo port install pkg-config
27 * set environment variable
28 * PKG_CONFIG_PATH=/usr/X11/lib/pkgconfig
31 execute
33   jam
35 to configure and
37   jam
39 again to build.
42 Using
43 -----
44 Copy .sterm.rc to ~/.sterm.rc
45 Copy ./sterm to /usr/local/bin
46 Type "sterm" to run sterm in rxvt mode.
47 Type "sterm -T xterm" to run sterm in xterm mode.
50 Configuration
51 -------------
52 sterm searches config files in this order:
54   ~/.sterm.rc
55   ~/.config/sterm.rc
56   /etc/sterm.rc
57   /etc/sterm/sterm.rc
58   ./.sterm.rc
61 Features that will not be added
62 -------------------------------
63   * transparency
64   * ttf font support
65   * scripting
66   * japanese and other strange languages
67   * unnecessary (for me) bloating
70 Credits
71 -------
72 Based on AurĂ©lien APTEL <aurelien dot aptel at gmail dot com> bt source code.
73 Heavily modified by Ketmar // Invisible Vector (xmpp/email: ketmar@ketmar.no-ip.org)
74 Mac OS X support: vb <vctr.br@mail.ru>