Debian Codegraph @

README

raw
1 #
2 # MP3Roaster README
3 #
4 # $Id: README,v 1.7 2005/10/09 14:00:02 eim Exp $
5 #
6
7 0. Index
8 --------
9
10 0. Index
11 1. Introduction
12 2. About MP3Roaster
13 3. Why I've started this project
14 4. MP3Roaster configuration
15 5. MP3Roaster configuration options
16 6. Usage syntax
17 7. Additional help
18 8. How to contribute
19
20
21 1. Introduction
22 ---------------
23
24 Welcome to the MP3Roaster README file.
25
26 In this README file I explain what MP3Roaster is, why I've started this
27 project and why it could be useful for you and last but not least some
28 informations on how you can be involved in the MP3Roaster development
29 process, have fun reading!
30
31
32 2. About MP3Roaster
33 -------------------
34
35 MP3Roaster is a Perl hack for burning audio CDs out of MP3, OGG Vorbis
36 FLAC and WAV files. The main highlights of this application are an easy to
37 use command line syntax and automatic volume leveling support for best audio
38 CD quality.
39
40
41 3. Why I've started this project
42 --------------------------------
43
44 The answer is quite simple and I think it's also the main reason why most
45 people out there start new Open Source projects every day: the fun to code.
46
47 Well, I was searching for an user friendly application to create audio CD out
48 of MP3 files but all the programs I've found, both GUI and text oriented, were
49 not able to satisfy my needs so I decided to write my own application.
50
51 Of course MP3Roaster is just one solution to create your audio CD, there are
52 many other good projects out there which aim to the same objective, this
53 program is my attempt to suite my needs, if you like it, use it, simple ;)
54
55
56 4. MP3Roaster configuration
57 ---------------------------
58
59 MP3Roaster can be configured through a system wide and a personal
60 configuration file.
61
62 When you run MP3Roaster it will first check for your personal configuration
63 file in your home directory, if no one is found it will fall-back to the
64 system wide configuration files placed in /etc.
65
66 By default MP3Roaster installs the configuration files in /etc/mp3roaster,
67 but there are other possible file locations for the configuration file:
68
69 . System wide configuration in /etc
70
71 . /etc/mp3roaster/mp3roasterrc (DEFAULT)
72 . /etc/mp3roasterrc
73
74 . Personal configuration in your home
75
76 . ~/.mp3roaster/mp3roasterrc
77 . ~/.mp3roasterrc
78
79 So if you want to have personal MP3Roaster configuration file just copy
80 the system wide configuration file to your home directory and edit it.
81
82
83 5. MP3Roaster configuration options
84 -----------------------------------
85
86 All configuration options are explained in the system wide example
87 configuration file.
88
89
90 6. Usage syntax
91 ---------------
92
93 Once correctly configured MP3Roaster is very easy to use, just launch it
94 from the command line with a bunch of compressed audio files, here is a
95 short example:
96
97 % mp3roaster "Root Dance.mp3" Free\ Software.flac bar.ogg Decoded.wav
98
99 This will burn Root\ Dance.mp3, Free\ Software.flac bar.ogg and Decoded.wav
100 on your audio CD preserving the song order as specified on the command line.
101
102 Here is another example showing the usage of command line options like
103 the dummy option:
104
105 % mp3roaster -d "Root Dance.mp3" Free\ Software.flac bar.ogg Decoded.wav
106
107 This will do the same job as above but with the laser of your
108 CD writer turned off, so no data will be really written.
109
110 You see MP3Roaster is really easy to use, this was one of my main goals
111 while I've written the code: Keep it simple ;)
112
113
114 7. Additional help
115 ------------------
116
117 Additional help to MP3Roaster can be found on the project web page which is
118 available on http://mp3roaster.sourceforge.net or in the projects users
119 mailing list [email protected]
120
121
122 8. How to contribute
123 --------------------
124
125 If you are interested in contributing to the project you can get in contact
126 with the MP3Roaster developers using the devel mailing list available at
127 [email protected]
128
129 If you would like to get in contact with other MP3Roaster users please use
130 the [email protected] mailing list, of course you will
131 also find MP3Roaster developers on this mailing list.
132
133 Feel free to submit any kind of development related informations like patches,
134 bug fixes, improvements or just comments and suggestion, we will look forward
135 to reply as soon as possible, thank you.