History

Convert readme.txt to Markdown

Andreas Gnau committed 9 years ago

Commit 13a21441 parent cbbaa561 file · +70 −94Browse files

Unified · Split

README.mdrenamed from readme.txt+70−94
@@ -1,42 +1,41 @@
1/* _______ ____ __ ___ ___1# Dynamic Universal Music Bibliotheque (libdumb)
2 * \ _ \ \ / \ / \ \ / / ' ' '2
3 * | | \ \ | | || | \/ | . .3 _______ ____ __ ___ ___
4 * | | | | | | || ||\ /| |4 \ _ \ \ / \ / \ \ / / ' ' '
5 * | | | | | | || || \/ | | ' ' '5 | | \ \ | | || | \/ | . .
6 * | | | | | | || || | | . .6 | | | | | | || ||\ /| |
7 * | |_/ / \ \__// || | |7 | | | | | | || || \/ | | ' ' '
8 * /_______/ynamic \____/niversal /__\ /____\usic /| . . ibliotheque8 | | | | | | || || | | . .
9 * / \9 | |_/ / \ \__// || | |
10 * / . \10 /_______/ynamic \____/niversal /__\ /____\usic /| . . ibliotheque
11 * readme.txt - General information on DUMB. / / \ \11 / \
12 * | < / \_12 / . \
13 * | \/ /\ /13 / / \ \
14 * \_ / > /14 | < / \_
15 * | \ / /15 | \/ /\ /
16 * | ' /16 \_ / > /
17 * \__/17 | \ / /
18 */18 | ' /
19 19 \__/
20 20
21********************21
22*** Introduction ***22
23********************23## Introduction
24
25 24
26Thank you for downloading DUMB v0.9.3! You should have the following25Thank you for downloading DUMB v0.9.3! You should have the following
27documentation:26documentation:
28 27
29 readme.txt - This file28 * readme.txt - This file
30 licence.txt - Conditions for the use of this software29 * licence.txt - Conditions for the use of this software
31 release.txt - Release notes and changes for this and past releases30 * release.txt - Release notes and changes for this and past releases
32 docs/31 * docs/
33 howto.txt - Step-by-step instructions on adding DUMB to your project32 * howto.txt - Step-by-step instructions on adding DUMB to your project
34 faq.txt - Frequently asked questions and answers to them33 * faq.txt - Frequently asked questions and answers to them
35 dumb.txt - DUMB library reference34 * dumb.txt - DUMB library reference
36 deprec.txt - Information about deprecated parts of the API35 * deprec.txt - Information about deprecated parts of the API
37 ptr.txt - Quick introduction to pointers for those who need it36 * ptr.txt - Quick introduction to pointers for those who need it
38 fnptr.txt - Explanation of function pointers for those who need it37 * fnptr.txt - Explanation of function pointers for those who need it
39 modplug.txt - Our official position regarding ModPlug Tracker38 * modplug.txt - Our official position regarding ModPlug Tracker
40 39
41This file will help you get DUMB set up. If you have not yet done so, please40This file will help you get DUMB set up. If you have not yet done so, please
42read licence.txt and release.txt before proceeding. After you've got DUMB set41read licence.txt and release.txt before proceeding. After you've got DUMB set
@@ -44,10 +43,7 @@ up, please refer to the files in the docs/ directory at your convenience. I · 1 unmodified line
44recommend you start with howto.txt.43recommend you start with howto.txt.
45 44
46 45
47****************46## Features
48*** Features ***
49****************
50
51 47
52Here is the statutory feature list:48Here is the statutory feature list:
53 49
@@ -97,10 +93,7 @@ Here is the statutory feature list: · 43 unmodified lines
97 compiling it manually are available further down93 compiling it manually are available further down
98 94
99 95
100*********************96## What you need
101*** What you need ***
102*********************
103
104 97
105To use DUMB, you need a 32-bit C compiler (GCC and MSVC are fine). If you98To use DUMB, you need a 32-bit C compiler (GCC and MSVC are fine). If you
106have Allegro, DUMB can integrate with its audio streams and datafiles, making99have Allegro, DUMB can integrate with its audio streams and datafiles, making
@@ -111,9 +104,7 @@ Allegro. · 4 unmodified lines
111 Allegro - http://alleg.sf.net/104 Allegro - http://alleg.sf.net/
112 105
113 106
114**********************************************107## How to set DUMB up with DJGPP or MinGW
115*** How to set DUMB up with DJGPP or MinGW ***
116**********************************************
117 108
118 109
119You should have got the .zip version. If for some reason you got the .tar.gz110You should have got the .zip version. If for some reason you got the .tar.gz
@@ -134,11 +125,11 @@ Change to the directory into which you unzipped DUMB. · 14 unmodified lines
134 125
135If you are using MinGW (and you haven't renamed 'mingw32-make'), type:126If you are using MinGW (and you haven't renamed 'mingw32-make'), type:
136 127
137 mingw32-make128 mingw32-make
138 129
139Otherwise, type the following:130Otherwise, type the following:
140 131
141 make132 make
142 133
143DUMB will ask you whether you wish to compile for DJGPP or MinGW. Then it134DUMB will ask you whether you wish to compile for DJGPP or MinGW. Then it
144will ask you whether you want support for Allegro. (You have to have made and135will ask you whether you want support for Allegro. (You have to have made and
@@ -147,15 +138,15 @@ compile optimised and debugging builds of DUMB, along with the example · 2 unmodified lines
147programs. When it has finished, run one of the following to install the138programs. When it has finished, run one of the following to install the
148libraries:139libraries:
149 140
150 make install141 make install
151 mingw32-make install142 mingw32-make install
152 143
153All done! If you ever need the configuration again (e.g. if you compiled for144All done! If you ever need the configuration again (e.g. if you compiled for
154DJGPP before and you want to compile for MinGW now), run one of the145DJGPP before and you want to compile for MinGW now), run one of the
155following:146following:
156 147
157 make config148 make config
158 mingw32-make config149 mingw32-make config
159 150
160See the comments in the Makefile for other targets.151See the comments in the Makefile for other targets.
161 152
@@ -178,10 +169,7 @@ when you are ready to start programming with DUMB. If you use DUMB in a game, · 16 unmodified lines
178let me know - I might decide to place a link to your game on DUMB's website!169let me know - I might decide to place a link to your game on DUMB's website!
179 170
180 171
181******************************************************172## How to set DUMB up with Microsoft Visual C++ 6
182*** How to set DUMB up with Microsoft Visual C++ 6 ***
183******************************************************
184
185 173
186If you have a newer version of Microsoft Visual C++ or Visual Something that174If you have a newer version of Microsoft Visual C++ or Visual Something that
187supports C++, please try these instructions and let me know if it works.175supports C++, please try these instructions and let me know if it works.
@@ -266,10 +254,7 @@ start using DUMB, refer to docs/howto.txt. If you use DUMB in a game, let me · 78 unmodified lines
266know - I might decide to place a link to your game on DUMB's website!254know - I might decide to place a link to your game on DUMB's website!
267 255
268 256
269******************************************************257## How to set DUMB up on Linux, BeOS and Mac OS X
270*** How to set DUMB up on Linux, BeOS and Mac OS X ***
271******************************************************
272
273 258
274You should have got the .tar.gz version. If for some reason you got the .zip259You should have got the .tar.gz version. If for some reason you got the .zip
275version instead, you may have to strip all characters with ASCII code 13 from260version instead, you may have to strip all characters with ASCII code 13 from
@@ -288,7 +273,7 @@ If you are not using the configure script, the procedure is as follows. · 12 unmodified lines
288 273
289First, run the following command as a normal user:274First, run the following command as a normal user:
290 275
291 make276 make
292 277
293You will be asked whether you want Allegro support. Then, unless you are on278You will be asked whether you want Allegro support. Then, unless you are on
294BeOS, you will be asked where you'd like DUMB to install its headers,279BeOS, you will be asked where you'd like DUMB to install its headers,
@@ -299,7 +284,7 @@ not work. Once you have specified these pieces of information, the optimised · 4 unmodified lines
299and debugging builds of DUMB will be compiled, along with the examples. When284and debugging builds of DUMB will be compiled, along with the examples. When
300it has finished, you can install them with:285it has finished, you can install them with:
301 286
302 make install287 make install
303 288
304You may need to be root for this to work. It depends on the prefix you chose.289You may need to be root for this to work. It depends on the prefix you chose.
305 290
@@ -324,7 +309,7 @@ The default Makefile is a copy of Makefile.rdy (short for 'ready'), and it · 18 unmodified lines
324must exist with the name Makefile.rdy in order to work. The configure script309must exist with the name Makefile.rdy in order to work. The configure script
325will overwrite Makefile, so if you want the default Makefile back, just run:310will overwrite Makefile, so if you want the default Makefile back, just run:
326 311
327 cp Makefile.rdy Makefile312 cp Makefile.rdy Makefile
328 313
329Do not use a symlink, as that would result in Makefile.rdy getting314Do not use a symlink, as that would result in Makefile.rdy getting
330overwritten next time the configure script is run!315overwritten next time the configure script is run!
@@ -333,10 +318,7 @@ You can also access the usual build system by passing '-f Makefile.rdy' to · 2 unmodified lines
333Make.318Make.
334 319
335 320
336********************************************************321## How to build DUMB manually if nothing else works
337*** How to build DUMB manually if nothing else works ***
338********************************************************
339
340 322
341Those porting to platforms without floating point support should be aware323Those porting to platforms without floating point support should be aware
342that DUMB does use floating point operations but not in the inner loops. They324that DUMB does use floating point operations but not in the inner loops. They
@@ -387,16 +369,14 @@ by simple name with no path, then that is ideal. · 44 unmodified lines
387If you successfully port DUMB to a new platform, please let me know!369If you successfully port DUMB to a new platform, please let me know!
388 370
389 371
390****************************372## The example programs
391*** The example programs ***
392****************************
393
394 373
395Three example programs are provided. On DOS and Windows, you can find them in374Three example programs are provided. On DOS and Windows, you can find them in
396the examples subdirectory. On other systems they will be installed system-375the examples subdirectory. On other systems they will be installed system-
397wide.376wide.
398 377
399dumbplay378
379### dumbplay
400 This program will only be built if you have Allegro. Pass it the filename380 This program will only be built if you have Allegro. Pass it the filename
401 of an IT, XM, S3M or MOD file, and it will play it. It's not a polished381 of an IT, XM, S3M or MOD file, and it will play it. It's not a polished
402 player with real-time threading or anything - so don't complain about it382 player with real-time threading or anything - so don't complain about it
@@ -406,7 +386,9 @@ dumbplay · 3 unmodified lines
406 where the program is installed system-wide, but it is non-fatal.) Have a386 where the program is installed system-wide, but it is non-fatal.) Have a
407 look at the examples/dumb.ini file for further information.387 look at the examples/dumb.ini file for further information.
408 388
409dumbout389
390### dumbout
391
410 This program does not need Allegro. You can use it to stream an IT, XM,392 This program does not need Allegro. You can use it to stream an IT, XM,
411 S3M or MOD file to raw PCM. This can be used as input to an encoder like393 S3M or MOD file to raw PCM. This can be used as input to an encoder like
412 oggenc (with appropriate command-line options), or it can be sent to a394 oggenc (with appropriate command-line options), or it can be sent to a
@@ -415,15 +397,14 @@ dumbout · 2 unmodified lines
415 render a module with the module's playing time! dumbout doesn't try to397 render a module with the module's playing time! dumbout doesn't try to
416 read any configuration file; the options are set on the command line.398 read any configuration file; the options are set on the command line.
417 399
418dumb2wav400
401### dumb2wav
402
419 This program is much the same as dumbout, but it writes a .wav file with403 This program is much the same as dumbout, but it writes a .wav file with
420 the appropriate header. Thanks go to Chad Austin for this useful tool.404 the appropriate header. Thanks go to Chad Austin for this useful tool.
421 405
422 406
423*********************************************407## Downloading music or writing your own
424*** Downloading music or writing your own ***
425*********************************************
426
427 408
428If you would like to compose your own music modules, then this section should409If you would like to compose your own music modules, then this section should
429help get you started.410help get you started.
@@ -431,9 +412,9 @@ help get you started. · 1 unmodified line
431The best programs for the job are the trackers that pioneered the file412The best programs for the job are the trackers that pioneered the file
432formats:413formats:
433 414
434 Impulse Tracker - IT files - http://www.lim.com.au/ImpulseTracker/415* Impulse Tracker - IT files - http://www.lim.com.au/ImpulseTracker/
435 Fast Tracker II - XM files - http://www.fasttracker2.com/416* Fast Tracker II - XM files - http://www.fasttracker2.com/
436 Scream Tracker 3 - S3M files - No official site known, please use Google417* Scream Tracker 3 - S3M files - No official site known, please use Google
437 418
438MOD files come from the Amiga; I do not know what PC tracker to recommend for419MOD files come from the Amiga; I do not know what PC tracker to recommend for
439editing these. If you know of one, let me know! In the meantime, I would420editing these. If you know of one, let me know! In the meantime, I would
@@ -472,6 +453,7 @@ with it. There are plug-ins available to improve Winamp's module support, for · 32 unmodified lines
472example WSP.453example WSP.
473 454
474 Winamp - http://www.winamp.com/455 Winamp - http://www.winamp.com/
456
475 WSP - http://www.spytech.cz/index.php?sec=demo457 WSP - http://www.spytech.cz/index.php?sec=demo
476 458
477(There is a Winamp plug-in that uses DUMB, but it is unreliable. If anyone459(There is a Winamp plug-in that uses DUMB, but it is unreliable. If anyone
@@ -489,11 +471,11 @@ download samples at · 11 unmodified lines
489If you would like to download module files composed by other people, check471If you would like to download module files composed by other people, check
490the following sites:472the following sites:
491 473
492 http://www.modarchive.com/474 * http://www.modarchive.com/
493 http://www.scene.org/475 * http://www.scene.org/
494 http://www.tump.net/476 * http://www.tump.net/
495 http://www.homemusic.cc/main.php477 * http://www.homemusic.cc/main.php
496 http://www.modplug.com/478 * http://www.modplug.com/
497 479
498Once again, if you know of more sites where samples or module files are480Once again, if you know of more sites where samples or module files are
499available for download, please let me know.481available for download, please let me know.
@@ -516,10 +498,7 @@ loading), but future versions of DUMB will be able to rectify these mistakes. · 16 unmodified lines
516On the other hand, if you convert the file, the damage is permanent.498On the other hand, if you convert the file, the damage is permanent.
517 499
518 500
519***********************501## Contact details
520*** Contact details ***
521***********************
522
523 502
524If you have trouble with DUMB, or want to contact me for any other reason, my503If you have trouble with DUMB, or want to contact me for any other reason, my
525e-mail address is given below. Please do get in touch, even if I appear to504e-mail address is given below. Please do get in touch, even if I appear to
@@ -529,10 +508,7 @@ If you wish to chat online about something, perhaps on IRC, that can most · 3 unmodified lines
529likely be arranged. Send me an e-mail.508likely be arranged. Send me an e-mail.
530 509
531 510
532******************511## Conclusion
533*** Conclusion ***
534******************
535
536 512
537This is the conclusion.513This is the conclusion.
538 514

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t