From 717a186c17b9733ec13123dea60dd1e5274e33e8 Mon Sep 17 00:00:00 2001 From: zvon Date: Sat, 18 May 2019 15:15:11 +0200 Subject: [PATCH] Fix typos in README and add installation guide --- README.md | 31 ++++++++++++++++++++++++++++--- 1 file changed, 28 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 91f530c..2a3d006 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ Arguments: `-s, --show` - Name of the show -`-n, --season` - Seasons to be renamed (numbers seperated by space or 'all' for all seasons in the directory and sub directories) +`-n, --season` - Seasons to be renamed (numbers separated by space or 'all' for all seasons in the directory and sub directories) `-p, --show-path` - Path to the show's directory @@ -20,7 +20,7 @@ Arguments: `-t, --trust` - Don't prompt before changing file names -`-x, --linux` - Don't replace characters that are ilegal in NTFS +`-x, --linux` - Don't replace characters that are illegal in NTFS `-l, --lang` - Language of the episode titles @@ -32,4 +32,29 @@ Arguments: - %show - show name from thetvdb - %epname - episode name from thetvdb - %season - season number, possible to specify leading 0 like this: %2season (number means how many leading zeros) -- %episode - episode number, possible to specify leading 0 like this: %3season (number means how many leading zeros) \ No newline at end of file +- %episode - episode number, possible to specify leading 0 like this: %3season (number means how many leading zeros) + +## Installation + +For installation of command line version you'll need: + *libcurl-dev* (or your distro's equivalent) + some sort of C++ compiler (*clang++* for example) + *make* +When you have all prerequisites installed you need to do this sequence of commands: + git clone 'https://gitlab.com/zvon/tv_rename_cpp' + cd tv_rename_cpp + make + sudo make install + +For installation of GUI version you'll need: + *libcurl-dev* (or your distro's equivalent) + some sort of C++ compiler (*clang++* for example) + *make* + *libgtkmm* (or your distro's equivalent) +When you have all prerequisites installed you need to do this sequence of commands: + git clone 'https://gitlab.com/zvon/tv_rename_cpp' + cd tv_rename_cpp + make gui + sudo make install_gui + +You can uninstall both versions by running either `sudo make uninstall` or `sudo make uninstall_gui`