added README
[termu] / README.md
1 Termu - ADM3a (for now) X11 terminal emulator
2 =============================================
3
4 About
5 -----
6 I needed to test the termtris ADM3a backend, so I decided to write an ADM3a
7 terminal emulator. Eventually if the stars align I might continue hacking on it
8 and add support for more emulated terminals, so I decided on a generic project
9 name. Another potential vector of improvement is to make it look like the real
10 terminal as much as possible, which is why I decided to use OpenGL for drawing.
11
12 For now it's incomplete and extremely bare-bones, but enough to verify that
13 termtris does in fact work on the ADM3a.
14
15 License
16 -------
17 Copyright (c) 2023 John Tsiombikas <nuclear@mutantstargoat.com>
18
19 This program is free software. Feel free to use, modify, and/or redistribute it,
20 under the terms of the GNU General Public License version 3, or at your option
21 any later version published by the Free Software Foundation. See COPYING for
22 details.
23
24 Build
25 -----
26 The repo does not include the binary character generator ROMs of the ADM3a. Grab
27 the `data` directory from a release archive.
28
29 Run `make` to build.