Fix typos in README and add installation guide

This commit is contained in:
zvon 2019-05-18 15:15:11 +02:00
parent 425941b50e
commit 717a186c17

View File

@ -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)
- %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`