minor makefile fixes
[retrobench] / README.md
1 Retrobench
2 ==========
3 A multi-platform framebuffer drawing performance benchmark targetted towards
4 retro PCs.
5
6 Retrobench intends to test how different operating systems, drawing methods,
7 and graphics hardware, affect drawing performance for a pure software rendering,
8 framebuffer access context.
9
10 Currently implemented benchmarks:
11
12   - Fast XOR pattern scrolling: pure framebuffer write speed testing
13
14 Currently supported platforms/drawing methods:
15
16   - UNIX X11 with the X shared memory extension (XShmPutImage).
17   - GNU/Linux with framebuffer console (fbdev).
18   - DOS direct framebuffer access through VESA BIOS Extensions (VBE).
19
20 Read about why I started this, and my initial findings:
21 http://nuclear.mutantstargoat.com/blog/100-fbperf_experiments.html
22
23 License
24 -------
25 Copyright (C) 2021 John Tsiombikas <nuclear@member.fsf.org>
26
27 This program is free software. Feel free to use, modify, and/or redistribute it
28 under the terms of the GNU General Public License v3, or at your option any
29 later version published by the Free Software Foundation. See COPYING for
30 details.
31
32 Build on UNIX
33 -------------
34 Simply typing `make` should build both the X11 and fbdev version of the
35 benchmark. The only dependency is Xlib, for the X11 version.
36
37 Build on DOS
38 ------------
39 Set up a DJGPP build environment and type `make -f Makefile.dj`.