From 6fc7ce901793784ce9efaefbc409ee2bff49eb0b Mon Sep 17 00:00:00 2001 From: thisiszeev Date: Tue, 19 Sep 2023 14:49:35 +0200 Subject: [PATCH] Update 'README.md' Fixed formating --- README.md | 29 +++++++++++++++++++---------- 1 file changed, 19 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 81fdaea..fd2f9e6 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ BASH tool to convert cbr files to cbz files either in batch or one by one. -Download the tool using: +##Download the tool using: $ git clone git@git.zaks.web.za:thisiszeev/cbr2cbz.git @@ -12,15 +12,24 @@ $ sudo cp cbr2cbz.sh /usr/bin/cbr2cbz That's it. -Usage: cbr2cbz single "filename.cbr" - Convert a single file. -Usage: cbr2cbz all - Convert all files recursively from the current location. -Usage: cbr2cbz help - Display this text. +##Usage: -Warning: If conversion is successful, the original file(s) will be deleted. +###Convert a single file. +$ cbr2cbz single "filename.cbr" -Dependancies: - The script requires "zip" and "unrar". Please ensure they are installed before trying to run the script. A simple online search will help you with this. At a later stage I will build an install and update functionality which will do this automatically. \ No newline at end of file +###Convert all files recursively from the current location. + +$ cbr2cbz all + +### Display help text. + +$ cbr2cbz help + +###Warning: + +If conversion is successful, the original file(s) will be deleted. + +##Dependancies: + +The script requires "zip" and "unrar". Please ensure they are installed before trying to run the script. A simple online search will help you with this. At a later stage I will build an install and update functionality which will do this automatically. \ No newline at end of file