annotate README.txt @ 30:8f2855f9300c

Update documentation.
author Matti Hamalainen <ccr@tnsp.org>
date Thu, 25 Sep 2014 18:08:52 +0300
parents 46d21c77bbb1
children eabee1428b0a
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
30
8f2855f9300c Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 17
diff changeset
24 - th-libs lib
11
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
25
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
26 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
27 MinGW packages from Debian Testing (wheezy):
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
28
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
29 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
30
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
31 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
32
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
33 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
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
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
37 How to build
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
38 ============
30
8f2855f9300c Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 17
diff changeset
39 0) If building from Mercurial repo, you need th-libs:
8f2855f9300c Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 17
diff changeset
40
8f2855f9300c Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 17
diff changeset
41 $ hg clone http://tnsp.org/hg/th-libs
11
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
42
30
8f2855f9300c Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 17
diff changeset
43 1) Possibly edit Makefile / Makefile.w32
8f2855f9300c Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 17
diff changeset
44
8f2855f9300c Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 17
diff changeset
45 2) $ gmake
8f2855f9300c Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 17
diff changeset
46
11
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
47 or, if cross-compiling to Win32 via MinGW
30
8f2855f9300c Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 17
diff changeset
48
11
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
49 $ gmake -f Makefile.w32
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
50
30
8f2855f9300c Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 17
diff changeset
51 3) ???
11
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
52
30
8f2855f9300c Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 17
diff changeset
53 4) If it works -> Happy fun times \:D\
11
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
54
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
55 -----------------------------------------------------------------------
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
56
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
57 Usage
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
58 =====
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
59
17
46d21c77bbb1 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
60 $ ./sidinfo /misc/C64Music/MUSICIANS/J/Jeff/Anal_ogue.sid
46d21c77bbb1 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
61 Filename : /misc/C64Music/MUSICIANS/J/Jeff/Anal_ogue.sid
46d21c77bbb1 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
62 Type : PSID
46d21c77bbb1 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
63 Version : 2.0
46d21c77bbb1 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
64 Data offset : 124
46d21c77bbb1 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
65 Data size : 7154
46d21c77bbb1 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
66 Load address : 0
46d21c77bbb1 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
67 Init address : 4017
46d21c77bbb1 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
68 Play address : 4027
46d21c77bbb1 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
69 Songs : 1
46d21c77bbb1 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
70 Start song : 1
46d21c77bbb1 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
71 Name : Anal'ogue
46d21c77bbb1 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
72 Author : Søren Lund (Jeff)
46d21c77bbb1 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
73 Copyright : 1996 Jeff
46d21c77bbb1 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
74 Hash : 6d5b7f0ff092e55abf27c37c8bc3fc64
11
20bcf214b282 Add some "documentation" and a license.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
75
17
46d21c77bbb1 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
76
46d21c77bbb1 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
77 $ ./sidinfo /misc/C64Music/MUSICIANS/J/Jeff/Anal_ogue.sid -p -x
46d21c77bbb1 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
78 Filename=/misc/C64Music/MUSICIANS/J/Jeff/Anal_ogue.sid
46d21c77bbb1 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
79 Type=PSID
46d21c77bbb1 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
80 Version=2.0
46d21c77bbb1 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
81 DataOffs=$0000007c
46d21c77bbb1 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
82 DataSize=$00001bf2
46d21c77bbb1 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
83 LoadAddr=$0000
46d21c77bbb1 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
84 InitAddr=$0fb1
46d21c77bbb1 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
85 PlayAddr=$0fbb
46d21c77bbb1 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
86 Songs=$0001
46d21c77bbb1 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
87 StartSong=$0001
46d21c77bbb1 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
88 Name=Anal'ogue
46d21c77bbb1 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
89 Author=Søren Lund (Jeff)
46d21c77bbb1 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
90 Copyright=1996 Jeff
46d21c77bbb1 Update documentation.
Matti Hamalainen <ccr@tnsp.org>
parents: 11
diff changeset
91 Hash=6d5b7f0ff092e55abf27c37c8bc3fc64