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−/* _______ ____ __ ___ ___
2− * \ _ \ \ / \ / \ \ / / ' ' '
3− * | | \ \ | | || | \/ | . .
4− * | | | | | | || ||\ /| |
5− * | | | | | | || || \/ | | ' ' '
6− * | | | | | | || || | | . .
7− * | |_/ / \ \__// || | |
8− * /_______/ynamic \____/niversal /__\ /____\usic /| . . ibliotheque
9− * / \
10− * / . \
11− * readme.txt - General information on DUMB. / / \ \
12− * | < / \_
13− * | \/ /\ /
14− * \_ / > /
15− * | \ / /
16− * | ' /
17− * \__/
18− */
19−
20−
21−********************
22−*** Introduction ***
23−********************
24−
1+# Dynamic Universal Music Bibliotheque (libdumb)
2+
3+ _______ ____ __ ___ ___
4+ \ _ \ \ / \ / \ \ / / ' ' '
5+ | | \ \ | | || | \/ | . .
6+ | | | | | | || ||\ /| |
7+ | | | | | | || || \/ | | ' ' '
8+ | | | | | | || || | | . .
9+ | |_/ / \ \__// || | |
10+ /_______/ynamic \____/niversal /__\ /____\usic /| . . ibliotheque
11+ / \
12+ / . \
13+ / / \ \
14+ | < / \_
15+ | \/ /\ /
16+ \_ / > /
17+ | \ / /
18+ | ' /
19+ \__/
20+
21+
22+
23+## Introduction
2524
2625 Thank you for downloading DUMB v0.9.3! You should have the following
2726 documentation:
2827
29− readme.txt - This file
30− licence.txt - Conditions for the use of this software
31− release.txt - Release notes and changes for this and past releases
32− docs/
33− howto.txt - Step-by-step instructions on adding DUMB to your project
34− faq.txt - Frequently asked questions and answers to them
35− dumb.txt - DUMB library reference
36− deprec.txt - Information about deprecated parts of the API
37− ptr.txt - Quick introduction to pointers for those who need it
38− fnptr.txt - Explanation of function pointers for those who need it
39− modplug.txt - Our official position regarding ModPlug Tracker
28+ * readme.txt - This file
29+ * licence.txt - Conditions for the use of this software
30+ * release.txt - Release notes and changes for this and past releases
31+ * docs/
32+ * howto.txt - Step-by-step instructions on adding DUMB to your project
33+ * faq.txt - Frequently asked questions and answers to them
34+ * dumb.txt - DUMB library reference
35+ * deprec.txt - Information about deprecated parts of the API
36+ * ptr.txt - Quick introduction to pointers for those who need it
37+ * fnptr.txt - Explanation of function pointers for those who need it
38+ * modplug.txt - Our official position regarding ModPlug Tracker
4039
4140 This file will help you get DUMB set up. If you have not yet done so, please
4241 read 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
4443 recommend you start with howto.txt.
4544
4645
47−****************
48−*** Features ***
49−****************
50−
46+## Features
5147
5248 Here is the statutory feature list:
5349
@@ -97,10 +93,7 @@ Here is the statutory feature list: · 43 unmodified lines
9793 compiling it manually are available further down
9894
9995
100−*********************
101−*** What you need ***
102−*********************
103−
96+## What you need
10497
10598 To use DUMB, you need a 32-bit C compiler (GCC and MSVC are fine). If you
10699 have Allegro, DUMB can integrate with its audio streams and datafiles, making
@@ -111,9 +104,7 @@ Allegro. · 4 unmodified lines
111104 Allegro - http://alleg.sf.net/
112105
113106
114−**********************************************
115−*** How to set DUMB up with DJGPP or MinGW ***
116−**********************************************
107+## How to set DUMB up with DJGPP or MinGW
117108
118109
119110 You 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
134125
135126 If you are using MinGW (and you haven't renamed 'mingw32-make'), type:
136127
137− mingw32-make
128+ mingw32-make
138129
139130 Otherwise, type the following:
140131
141− make
132+ make
142133
143134 DUMB will ask you whether you wish to compile for DJGPP or MinGW. Then it
144135 will 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
147138 programs. When it has finished, run one of the following to install the
148139 libraries:
149140
150− make install
151− mingw32-make install
141+ make install
142+ mingw32-make install
152143
153144 All done! If you ever need the configuration again (e.g. if you compiled for
154145 DJGPP before and you want to compile for MinGW now), run one of the
155146 following:
156147
157− make config
158− mingw32-make config
148+ make config
149+ mingw32-make config
159150
160151 See the comments in the Makefile for other targets.
161152
@@ -178,10 +169,7 @@ when you are ready to start programming with DUMB. If you use DUMB in a game, · 16 unmodified lines
178169 let me know - I might decide to place a link to your game on DUMB's website!
179170
180171
181−******************************************************
182−*** How to set DUMB up with Microsoft Visual C++ 6 ***
183−******************************************************
184−
172+## How to set DUMB up with Microsoft Visual C++ 6
185173
186174 If you have a newer version of Microsoft Visual C++ or Visual Something that
187175 supports 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
266254 know - I might decide to place a link to your game on DUMB's website!
267255
268256
269−******************************************************
270−*** How to set DUMB up on Linux, BeOS and Mac OS X ***
271−******************************************************
272−
257+## How to set DUMB up on Linux, BeOS and Mac OS X
273258
274259 You should have got the .tar.gz version. If for some reason you got the .zip
275260 version 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
288273
289274 First, run the following command as a normal user:
290275
291− make
276+ make
292277
293278 You will be asked whether you want Allegro support. Then, unless you are on
294279 BeOS, 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
299284 and debugging builds of DUMB will be compiled, along with the examples. When
300285 it has finished, you can install them with:
301286
302− make install
287+ make install
303288
304289 You may need to be root for this to work. It depends on the prefix you chose.
305290
@@ -324,7 +309,7 @@ The default Makefile is a copy of Makefile.rdy (short for 'ready'), and it · 18 unmodified lines
324309 must exist with the name Makefile.rdy in order to work. The configure script
325310 will overwrite Makefile, so if you want the default Makefile back, just run:
326311
327− cp Makefile.rdy Makefile
312+ cp Makefile.rdy Makefile
328313
329314 Do not use a symlink, as that would result in Makefile.rdy getting
330315 overwritten 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
333318 Make.
334319
335320
336−********************************************************
337−*** How to build DUMB manually if nothing else works ***
338−********************************************************
339−
321+## How to build DUMB manually if nothing else works
340322
341323 Those porting to platforms without floating point support should be aware
342324 that 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
387369 If you successfully port DUMB to a new platform, please let me know!
388370
389371
390−****************************
391−*** The example programs ***
392−****************************
393−
372+## The example programs
394373
395374 Three example programs are provided. On DOS and Windows, you can find them in
396375 the examples subdirectory. On other systems they will be installed system-
397376 wide.
398377
399−dumbplay
378+
379+### dumbplay
400380 This program will only be built if you have Allegro. Pass it the filename
401381 of an IT, XM, S3M or MOD file, and it will play it. It's not a polished
402382 player with real-time threading or anything - so don't complain about it
@@ -406,7 +386,9 @@ dumbplay · 3 unmodified lines
406386 where the program is installed system-wide, but it is non-fatal.) Have a
407387 look at the examples/dumb.ini file for further information.
408388
409−dumbout
389+
390+### dumbout
391+
410392 This program does not need Allegro. You can use it to stream an IT, XM,
411393 S3M or MOD file to raw PCM. This can be used as input to an encoder like
412394 oggenc (with appropriate command-line options), or it can be sent to a
@@ -415,15 +397,14 @@ dumbout · 2 unmodified lines
415397 render a module with the module's playing time! dumbout doesn't try to
416398 read any configuration file; the options are set on the command line.
417399
418−dumb2wav
400+
401+### dumb2wav
402+
419403 This program is much the same as dumbout, but it writes a .wav file with
420404 the appropriate header. Thanks go to Chad Austin for this useful tool.
421405
422406
423−*********************************************
424−*** Downloading music or writing your own ***
425−*********************************************
426−
407+## Downloading music or writing your own
427408
428409 If you would like to compose your own music modules, then this section should
429410 help get you started.
@@ -431,9 +412,9 @@ help get you started. · 1 unmodified line
431412 The best programs for the job are the trackers that pioneered the file
432413 formats:
433414
434− Impulse Tracker - IT files - http://www.lim.com.au/ImpulseTracker/
435− Fast Tracker II - XM files - http://www.fasttracker2.com/
436− Scream Tracker 3 - S3M files - No official site known, please use Google
415+* Impulse Tracker - IT files - http://www.lim.com.au/ImpulseTracker/
416+* Fast Tracker II - XM files - http://www.fasttracker2.com/
417+* Scream Tracker 3 - S3M files - No official site known, please use Google
437418
438419 MOD files come from the Amiga; I do not know what PC tracker to recommend for
439420 editing 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
472453 example WSP.
473454
474455 Winamp - http://www.winamp.com/
456+
475457 WSP - http://www.spytech.cz/index.php?sec=demo
476458
477459 (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
489471 If you would like to download module files composed by other people, check
490472 the following sites:
491473
492− http://www.modarchive.com/
493− http://www.scene.org/
494− http://www.tump.net/
495− http://www.homemusic.cc/main.php
496− http://www.modplug.com/
474+ * http://www.modarchive.com/
475+ * http://www.scene.org/
476+ * http://www.tump.net/
477+ * http://www.homemusic.cc/main.php
478+ * http://www.modplug.com/
497479
498480 Once again, if you know of more sites where samples or module files are
499481 available 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
516498 On the other hand, if you convert the file, the damage is permanent.
517499
518500
519−***********************
520−*** Contact details ***
521−***********************
522−
501+## Contact details
523502
524503 If you have trouble with DUMB, or want to contact me for any other reason, my
525504 e-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
529508 likely be arranged. Send me an e-mail.
530509
531510
532−******************
533−*** Conclusion ***
534−******************
535−
511+## Conclusion
536512
537513 This is the conclusion.
538514

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