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