annotate README @ 43:8a7589da1bec

Update documentation.
author Matti Hamalainen <ccr@tnsp.org>
date Tue, 19 Mar 2013 05:09:41 +0200
parents 61822816bba8
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
40
61822816bba8 Added a new README.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
1 3x666 by ocsa (c) 1998
61822816bba8 Added a new README.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
2 An intro for *NIX/Linux
61822816bba8 Added a new README.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
3
61822816bba8 Added a new README.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
4 Original code, music, graphics by viznut/PWP (and ocsa)
61822816bba8 Added a new README.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
5
61822816bba8 Added a new README.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
6 Ported to libSDL by ccr/TNSP^PWP <ccr@tnsp.org> in March of 2013
61822816bba8 Added a new README.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
7
43
8a7589da1bec Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 40
diff changeset
8 Usage
8a7589da1bec Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 40
diff changeset
9 =====
8a7589da1bec Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 40
diff changeset
10 There are some commandline options for choosing a resolution,
8a7589da1bec Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 40
diff changeset
11 and starting in full screen mode:
8a7589da1bec Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 40
diff changeset
12
8a7589da1bec Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 40
diff changeset
13 -f Start in full screen
8a7589da1bec Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 40
diff changeset
14 -h/-? Show this help
8a7589da1bec Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 40
diff changeset
15 -v<0-2> Video 0=320x200, 1=640x480 (default), 2=1280x720 (ws)
8a7589da1bec Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 40
diff changeset
16 -s<freq> Audio frequency (44100)
8a7589da1bec Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 40
diff changeset
17
8a7589da1bec Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 40
diff changeset
18 You can also switch between fullscreen via 'f' or the more
8a7589da1bec Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 40
diff changeset
19 traditional alt+enter. Esc exits, as per usual.
8a7589da1bec Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 40
diff changeset
20
40
61822816bba8 Added a new README.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
21
61822816bba8 Added a new README.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
22 Building
61822816bba8 Added a new README.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
23 ========
61822816bba8 Added a new README.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
24 To build for *NIX style platforms, you need
61822816bba8 Added a new README.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
25
61822816bba8 Added a new README.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
26 - A working C compiler, GCC 4.7 or clang 3.0 (LLVM 3.0) should work.
61822816bba8 Added a new README.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
27 - Make (GNU Make preferred)
61822816bba8 Added a new README.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
28 - libSDL 1.2. tested with 1.2.15 + development headers
61822816bba8 Added a new README.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
29
61822816bba8 Added a new README.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
30 $ make
61822816bba8 Added a new README.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
31
61822816bba8 Added a new README.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
32 ...
61822816bba8 Added a new README.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
33
61822816bba8 Added a new README.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
34 It is possible to cross-compile for Win32 using *NIX-hosted MinGW
61822816bba8 Added a new README.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
35 cross-compiler, as available in Debian for example. You will also
61822816bba8 Added a new README.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
36 need to have libSDL cross-compiled for the target, of course.
61822816bba8 Added a new README.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
37
61822816bba8 Added a new README.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
38 At least binutils-mingw-w64-i686 gcc-mingw-w64-i686 mingw-w64-i686-dev
61822816bba8 Added a new README.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
39 are needed .. 64-bit build should be possible as well, but you need
61822816bba8 Added a new README.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
40 to modify the Makefile.
61822816bba8 Added a new README.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
41
61822816bba8 Added a new README.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
42 $ make -f Makefile.w32
61822816bba8 Added a new README.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
43
61822816bba8 Added a new README.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
44
61822816bba8 Added a new README.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
45 Enjoy!
61822816bba8 Added a new README.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
46 -- ccr, 19.3.2013