annotate README @ 86:71394f177c0f

Bump version.
author Matti Hamalainen <ccr@tnsp.org>
date Tue, 19 Mar 2013 07:25:50 +0200
parents 3abba0311c07
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
39
f17a3dc38f2a New documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
1
f17a3dc38f2a New documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
2 MMmmmmmmMM
f17a3dc38f2a New documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
3 MM
f17a3dc38f2a New documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
4 xxxxxxxxxxxx
f17a3dc38f2a New documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
5 xxxxxxxxxxxxxxxxxxx
f17a3dc38f2a New documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
6 xxxxxxxxx
f17a3dc38f2a New documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
7 ZZZZZ.... %%%%%%%%% %%% %%% %%%%%%%%%
f17a3dc38f2a New documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
8 @@@@...... %%%%%%%%%. %%%....... %%%. %%%%%%%%%....
f17a3dc38f2a New documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
9 @@@@....o. .....%%% %%% %%% %%% %%% %%% %%%
f17a3dc38f2a New documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
10 @@@@@@@.... %%% %%% %%% %%% %%% %%% %%%
f17a3dc38f2a New documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
11 @@@@@@@@@@@ %%%% %%% %%% %%% %%% %%%% %%%
f17a3dc38f2a New documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
12 @@@@@@@@@@@@@ %%%% %%% %%% %%% %%% %%%% %%%
f17a3dc38f2a New documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
13 @@@@@@@@@@@@@@@ %%%%%%%%% %%% %%% %%% %%%%%%%%%
f17a3dc38f2a New documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
14 @@@@ %%%%%%%%% %%% %%% %%% %%%%%%%%%
f17a3dc38f2a New documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
15 @@@@@@ %%% %%%%% %%% %%% %%%
f17a3dc38f2a New documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
16 @@@@@@@@@@ xx %%% %%%%% %%% %%% %%%
f17a3dc38f2a New documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
17 @@@@@@@@@@@@@@ %%% %%%%% %%%% %%% %%%
f17a3dc38f2a New documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
18 @@@@@@@@@@@ %%% %%%%% %%%% %%% %%%
f17a3dc38f2a New documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
19 @@@@@@@@@ .....%%%....... %%%%%%%%%%%%%%. %%%..........
f17a3dc38f2a New documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
20 @@@@@ %%% %%%%%%%%%%%%%% %%%
f17a3dc38f2a New documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
21 @@@@
f17a3dc38f2a New documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
22
86
71394f177c0f Bump version.
Matti Hamalainen <ccr@tnsp.org>
parents: 79
diff changeset
23 libSDL-enhanced pwplib v1.97
48
382c1136ea40 Better quote.
Matti Hamalainen <ccr@tnsp.org>
parents: 44
diff changeset
24
382c1136ea40 Better quote.
Matti Hamalainen <ccr@tnsp.org>
parents: 44
diff changeset
25 in the year 2010 of our lameness
39
f17a3dc38f2a New documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
26
f17a3dc38f2a New documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
27
44
ec1bff613ae0 Documentation clarifications.
Matti Hamalainen <ccr@tnsp.org>
parents: 41
diff changeset
28 Original pwplib 1.90 and everything else
ec1bff613ae0 Documentation clarifications.
Matti Hamalainen <ccr@tnsp.org>
parents: 41
diff changeset
29 by viznut/pwp
39
f17a3dc38f2a New documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
30
44
ec1bff613ae0 Documentation clarifications.
Matti Hamalainen <ccr@tnsp.org>
parents: 41
diff changeset
31 SDL-support, cleanups, bugfixes and new buildsystem
ec1bff613ae0 Documentation clarifications.
Matti Hamalainen <ccr@tnsp.org>
parents: 41
diff changeset
32 by ccr/TNSP^pwp <ccr@tnsp.org>
39
f17a3dc38f2a New documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
33
f17a3dc38f2a New documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
34
f17a3dc38f2a New documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
35 About
f17a3dc38f2a New documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
36 =====
f17a3dc38f2a New documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
37 The product at your fingertips is a cleaned up, slightly fixed
f17a3dc38f2a New documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
38 version of pwplib and everything else that came in pwpunix-1.90
f17a3dc38f2a New documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
39 package. It has been enhanced with libSDL support for video and
f17a3dc38f2a New documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
40 audio.
f17a3dc38f2a New documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
41
f17a3dc38f2a New documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
42 Why, some may ask -- the reason is simple: most of terminal-based
f17a3dc38f2a New documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
43 output methods provided by original pwplib do not work very well
f17a3dc38f2a New documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
44 in current UNIX systems, and adding support for graphical output
f17a3dc38f2a New documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
45 via libSDL seemed to be the easiest way to fix this.
f17a3dc38f2a New documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
46
f17a3dc38f2a New documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
47 Additionally sound support via SDL was introduced, and it is
f17a3dc38f2a New documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
48 possible to cross-compile the whole thing for Win32 via MinGW
f17a3dc38f2a New documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
49 hosted on Linux or other UNIX-ish platform.
f17a3dc38f2a New documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
50
f17a3dc38f2a New documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
51
41
5828a0cb4d10 Add some more documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 39
diff changeset
52 Usage
5828a0cb4d10 Add some more documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 39
diff changeset
53 =====
5828a0cb4d10 Add some more documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 39
diff changeset
54 Information about available options can be viewed via:
5828a0cb4d10 Add some more documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 39
diff changeset
55
5828a0cb4d10 Add some more documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 39
diff changeset
56 > peluce help
5828a0cb4d10 Add some more documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 39
diff changeset
57
5828a0cb4d10 Add some more documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 39
diff changeset
58 Unfortunately (or fortunately) SDL for Windows redirects stdout and
5828a0cb4d10 Add some more documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 39
diff changeset
59 stderr by default, thus the help output goes to file "stdout.txt".
5828a0cb4d10 Add some more documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 39
diff changeset
60
39
f17a3dc38f2a New documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
61 By default the SDL target runs in a window of 640x480, but this
f17a3dc38f2a New documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
62 can be changed via commandline parameters. For example:
f17a3dc38f2a New documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
63
f17a3dc38f2a New documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
64 > peluce xres 1024 yres 768
f17a3dc38f2a New documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
65
f17a3dc38f2a New documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
66 Or run in full screen:
f17a3dc38f2a New documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
67
f17a3dc38f2a New documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
68 > peluce xres 1024 yres 768 fs
f17a3dc38f2a New documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
69
f17a3dc38f2a New documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
70
f17a3dc38f2a New documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
71 Requirements
f17a3dc38f2a New documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
72 ============
f17a3dc38f2a New documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
73
f17a3dc38f2a New documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
74 * libSDL for the SDL version.
f17a3dc38f2a New documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
75
f17a3dc38f2a New documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
76 * A working C compiler (preferably GCC3 or later)
f17a3dc38f2a New documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
77
f17a3dc38f2a New documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
78 * Make (GNU Make 3.81 or later works at least)
f17a3dc38f2a New documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
79
f17a3dc38f2a New documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
80 * POSIX-ish platform for building. Windows targets
f17a3dc38f2a New documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
81 can be built via cross-compilation.
f17a3dc38f2a New documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
82
f17a3dc38f2a New documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
83 Quick and dirty guide to make it: Just type 'make'
f17a3dc38f2a New documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
84 and follow the instructions.
f17a3dc38f2a New documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
85
f17a3dc38f2a New documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
86 The Windows cross-compilation targets most likely require
f17a3dc38f2a New documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
87 manual intervention, e.g. editing of the Makefile as this
f17a3dc38f2a New documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
88 has only been tested on one system.
f17a3dc38f2a New documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
89
58
6bddfed775f8 Add section about known bugs.
Matti Hamalainen <ccr@tnsp.org>
parents: 48
diff changeset
90
6bddfed775f8 Add section about known bugs.
Matti Hamalainen <ccr@tnsp.org>
parents: 48
diff changeset
91 Known bugs
6bddfed775f8 Add section about known bugs.
Matti Hamalainen <ccr@tnsp.org>
parents: 48
diff changeset
92 ==========
79
3abba0311c07 Add note about fisi.
Matti Hamalainen <ccr@tnsp.org>
parents: 66
diff changeset
93 * While there is a "final_isi" directory, the code there is mostly
3abba0311c07 Add note about fisi.
Matti Hamalainen <ccr@tnsp.org>
parents: 66
diff changeset
94 a dirty half-working hack, as Final Isi was not originally using
3abba0311c07 Add note about fisi.
Matti Hamalainen <ccr@tnsp.org>
parents: 66
diff changeset
95 pwplib. It should compile and run, but will not work correctly.
3abba0311c07 Add note about fisi.
Matti Hamalainen <ccr@tnsp.org>
parents: 66
diff changeset
96
58
6bddfed775f8 Add section about known bugs.
Matti Hamalainen <ccr@tnsp.org>
parents: 48
diff changeset
97 * Big resolutions (1600 x 1200 for example) seem to cause some prods
6bddfed775f8 Add section about known bugs.
Matti Hamalainen <ccr@tnsp.org>
parents: 48
diff changeset
98 partially malfunction, apparently due to some integer overflows.
6bddfed775f8 Add section about known bugs.
Matti Hamalainen <ccr@tnsp.org>
parents: 48
diff changeset
99 As a workaround, use 1024 x 768 or so at most or experiment.
6bddfed775f8 Add section about known bugs.
Matti Hamalainen <ccr@tnsp.org>
parents: 48
diff changeset
100
6bddfed775f8 Add section about known bugs.
Matti Hamalainen <ccr@tnsp.org>
parents: 48
diff changeset
101 * Sound might be slightly off-sync in some prods, but this is possibly
6bddfed775f8 Add section about known bugs.
Matti Hamalainen <ccr@tnsp.org>
parents: 48
diff changeset
102 due to the reason that it wasn't ever properly synced to begin with.
6bddfed775f8 Add section about known bugs.
Matti Hamalainen <ccr@tnsp.org>
parents: 48
diff changeset
103
6bddfed775f8 Add section about known bugs.
Matti Hamalainen <ccr@tnsp.org>
parents: 48
diff changeset
104