From d7f7823b6fcbea2702b707b7cb609fb1a37e9d2a Mon Sep 17 00:00:00 2001 From: cpomeroy <chris.pomeroy@hotmail.com> Date: Fri, 15 Sep 2017 02:11:13 +0000 Subject: [PATCH] Document update --- README.md | 75 ++++++++++++++++++------------------- 1 files changed, 37 insertions(+), 38 deletions(-) diff --git a/README.md b/README.md index 375e791..2d85be1 100644 --- a/README.md +++ b/README.md @@ -1,38 +1,37 @@ -# aaxconvert - -For converting aax files from audible to mp3 format. - -## Installing / Getting started - -You will need to have ffmpeg, python 2.7 and an activation/encryption key from audible. -```shell -packagemanager install ffmpeg -python aaxConvert.py --code <activationcode> <filename> - -``` - -This will create a mp3's from the aax file in the following path. -```shell -/<dpath>/<artist>/<title> -``` - -## Configuration - -*optional add a .authcode with the activation key from audible so it doesn't have to be typed in everytime - -#### --code -Type: `String` - -Activation Code from audible to decrypt files - -#### -s, --single - -Use this option to create a single file. This is false by default - -#### -d, --dpath - -Use this to set the destination path. Otherwise I will use the current directory - -#### -v, --verbose - -Verbose stdout logging. mainly for debug +# aaxconvert + +For converting aax files from audible to mp3 format. + +## Installing / Getting started + +You will need to have ffmpeg, python 2.7 and an activation/encryption key from audible. + + packagemanager install ffmpeg + python aaxConvert.py --code `activationcode' `filename' + + +This will create a mp3's from the aax file in the following path. + + /`dpath'/`artist'/`title' + +## Configuration + +\*optional add a .authcode with the activation key from audible so it doesn't have to be typed in everytime + +#### --code + +Type: `String` + +Activation Code from audible to decrypt files + +#### -s, --single + +Use this option to create a single file. This is false by default + +#### -d, --dpath + +Use this to set the destination path. Otherwise I will use the current directory + +#### -v, --verbose + +Verbose stdout logging. mainly for debug \ No newline at end of file -- Gitblit v1.10.0