diff 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
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README.txt	Thu Sep 25 02:25:46 2014 +0300
@@ -0,0 +1,54 @@
+SIDInfo - PSID/RSID information displayer
+Programmed and designed by Matti 'ccr' Hämäläinen
+(C) Copyright 2014 Tecnic Software productions (TNSP)
+
+See COPYING for license information.
+
+-----------------------------------------------------------------------
+
+Contact
+=======
+IRC    : ccr @ IRCNet, sometimes also Freenode
+e-mail : ccr@tnsp.org
+
+-----------------------------------------------------------------------
+
+Requirements
+============
+The compilation and usage of these utilities requires following
+software packages or functional equivalents installed:
+
+ - GCC (4.x, older ones might work as well)
+ - GNU binutils
+ - GNU Make
+
+For Linux -> Win32/64 cross-compilation I have used the standard
+MinGW packages from Debian Testing (wheezy):
+
+gcc-mingw-w64 mingw-w64-i686-dev mingw-w64-x86-64-dev
+
+Some of those require a bit of poking to get working properly, YMMV.
+
+Please don't ask me for help to get cross-compilation working.
+
+-----------------------------------------------------------------------
+
+How to build
+============
+0) Possibly edit Makefile / Makefile.w32
+
+1) $ gmake
+   or, if cross-compiling to Win32 via MinGW
+   $ gmake -f Makefile.w32
+
+2) ???
+
+3) If it works -> Happy fun times \:D\
+
+-----------------------------------------------------------------------
+
+Usage
+=====
+
+See "sidinfo --help", should be rather obvious.
+