annotate README.txt @ 11:20bcf214b282

Add some "documentation" and a license.
author Matti Hamalainen <ccr@tnsp.org>
date Thu, 25 Sep 2014 02:25:46 +0300
parents
children 46d21c77bbb1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
11
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
1 SIDInfo - PSID/RSID information displayer
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
2 Programmed and designed by Matti 'ccr' Hämäläinen
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
3 (C) Copyright 2014 Tecnic Software productions (TNSP)
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
4
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
5 See COPYING for license information.
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
6
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
7 -----------------------------------------------------------------------
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
8
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
9 Contact
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
10 =======
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
11 IRC : ccr @ IRCNet, sometimes also Freenode
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
12 e-mail : ccr@tnsp.org
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
13
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
14 -----------------------------------------------------------------------
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
15
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
16 Requirements
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
17 ============
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
18 The compilation and usage of these utilities requires following
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
19 software packages or functional equivalents installed:
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
20
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
21 - GCC (4.x, older ones might work as well)
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
22 - GNU binutils
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
23 - GNU Make
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
24
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
25 For Linux -> Win32/64 cross-compilation I have used the standard
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
26 MinGW packages from Debian Testing (wheezy):
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
27
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
28 gcc-mingw-w64 mingw-w64-i686-dev mingw-w64-x86-64-dev
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
29
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
30 Some of those require a bit of poking to get working properly, YMMV.
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
31
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
32 Please don't ask me for help to get cross-compilation working.
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
33
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
34 -----------------------------------------------------------------------
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
35
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
36 How to build
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
37 ============
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
38 0) Possibly edit Makefile / Makefile.w32
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
39
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
40 1) $ gmake
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
41 or, if cross-compiling to Win32 via MinGW
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
42 $ gmake -f Makefile.w32
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
43
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
44 2) ???
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
45
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
46 3) If it works -> Happy fun times \:D\
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
47
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
48 -----------------------------------------------------------------------
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
49
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
50 Usage
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
51 =====
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
52
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
53 See "sidinfo --help", should be rather obvious.
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
54