1. Eduardo Ferreira
  2. FLAC Manager

Commits

Eduardo Ferreira  committed 517cb76

Fooling around with the README filme.

  • Participants
  • Parent commits 74b5140
  • Branches master

Comments (0)

Files changed (1)

File README.md

View file
  • Ignore whitespace
 A set of simple Python scripts that allow a user to manage the conversion
 between several types of audio files:
 
-* wav2flac
-	* Encodes WAV files into the FLAC format with the maximum compression level
-* flac2wav
-	* Decodes FLAC files
-* wav2mp3
-	* Encodes WAV files into the MP3 format with the maximum compression level
+* `wav2flac`: encodes WAV files into the FLAC format with the maximum compression level
+* `flac2wav`: decodes FLAC files
+* `wav2mp3`: encodes WAV files into the MP3 format with the maximum compression level
 
 Instructions
 ------------
 
-The script can be invoked by using the following syntax:
-
-	flacmanager [-f] [filenames] [-d] [folder]
-
-The available options are:
-
-* -f => Specify a set of files to convert
-* -F => Folder with a set of files to convert
-* -d => Folder in which the generated MP3 files will be saved
-* -h => Display a help message with detailed information regarding the script
-* -v => Output the current version
+Soon...
 
 Examples
 --------
 
-A specific FLAC file is selected and the resulting MP3 file will be stored in
-the current folder (where the script is run).
-
-	flacmanager -f lovely_song.flac
-
-A specific FLAC file is selected and the resulting MP3 file will be stored in
-the given folder.
-
-	flacmanager -f lovely_song.flac -d ~/new_songs/
-
-A folder with a set of FLAC files is selected and the resulting MP3 files will
-be stored in the given folder.
-
-	flacmanager -F ~/songs/ -d ~/new_songs/
-
-A specific FLAC file and a folder with a set of FLAC files are selected, with
-the resulting MP3 files being stored in the given folder.
-
-	flacmanager -f lovely_song.flac -F ~/lovely_songs/ -d ~/new_songs/
+Soon...
 
 Versions
 --------
 
 Version 0.2.0 will have the following features:
 
-* @flac2wav@ will save any metadata present in ID3 tags to a text file and the
+* `flac2wav` will save any metadata present in ID3 tags to a text file and the
 album cover to an image file while decoding the given FLAC files
-* @wav2flac@ will have two additional command line arguments to import a text
+* `wav2flac` will have two additional command line arguments to import a text
 file with ID3 tags and an image file with an album cover
-* @wav2mp3@ needs to be implemented
+* `wav2mp3` needs to be implemented
 
 License
 -------