zv0n/tv_rename
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Updated README

Browse Source
This commit is contained in:
zvon 2020-05-10 00:51:16 +02:00
parent 466ca9f90d
commit 2804c7cc40
1 changed files with 23 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
README.md
View File

@ -1,15 +1,13 @@
[![pipeline status](https://gitlab.com/zvon/tv_rename_cpp/badges/master/pipeline.svg)](https://gitlab.com/zvon/tv_rename_cpp/-/commits/master)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/9aace967ca614da4bdb7a500f63858dd)](https://www.codacy.com/manual/tom.zvon/tv_rename_cpp?utm_source=gitlab.com&utm_medium=referral&utm_content=zvon/tv_rename_cpp&utm_campaign=Badge_Grade)
[![Codacy Badge](https://api.codacy.com/project/badge/Coverage/9aace967ca614da4bdb7a500f63858dd)](https://www.codacy.com/manual/tom.zvon/tv_rename_cpp?utm_source=gitlab.com&utm_medium=referral&utm_content=zvon/tv_rename_cpp&utm_campaign=Badge_Coverage)
[![pipeline status](https://gitlab.com/zvon/tv_rename/badges/master/pipeline.svg)](https://gitlab.com/zvon/tv_rename/-/commits/master)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/9aace967ca614da4bdb7a500f63858dd)](https://www.codacy.com/manual/tom.zvon/tv_rename?utm_source=gitlab.com&utm_medium=referral&utm_content=zvon/tv_rename&utm_campaign=Badge_Grade)
[![Codacy Badge](https://api.codacy.com/project/badge/Coverage/9aace967ca614da4bdb7a500f63858dd)](https://www.codacy.com/manual/tom.zvon/tv_rename?utm_source=gitlab.com&utm_medium=referral&utm_content=zvon/tv_rename&utm_campaign=Badge_Coverage)
# Rename TV Show files
This program downloads episode names from <http://thetvdb.com> and adds them as a suffix to the appropriate files
This program downloads information about TV show episodes from <http://thetvdb.com> and renames episode files according to supplied name pattern.
For this to work your file needs to contain the season and episode number (in accordance to thetvdb) in this format: S#E# (doesn't matter if lower or upper case)
The program only supports the aired order so far
## Usage
Enter the directory in which the files you want to rename are (you can have subdirectories with different seasons, just not different shows) and call the program
You can either just rename files in a directory (this is done recursively, so you can enter a directory with multiple seasons, but all the files have to be from a single show). Or you can add a directory to local database, so when you add a new episode to the directory you just need to run database update for the file to be renamed.
Arguments:
@ -17,7 +15,7 @@ Arguments:
`-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
`-d, --dvd` - use DVD ordering instead of aired ordering
`-c, --correct-path` - Don't ask if path is correct
@ -37,17 +35,30 @@ Arguments:
- %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)
`--db-add` - Add path to database
`--db-refresh` - Refresh episode names for all paths in the database
`--db-update` - Check all paths in the database, if they contain new files, rename them
`--db-name-pattern` - Change name pattern used for files managed by the database
`--db-clean` - Remove deleted files from the database
`--db-remove` - Remove path from the database
## Installation
For installation of command line version you'll need:
- *libcurl-dev* (or your distro's equivalent)
- *sqlite-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'
git clone 'https://gitlab.com/zvon/tv_rename.git'
cd tv_rename_cpp
git submodule update --init
make
@ -56,9 +67,10 @@ When you have all prerequisites installed you need to do this sequence of comman
For installation of GUI version you'll need:
- *libcurl-dev* (or your distro's equivalent)
- *sqlite-dev* (or your distro's equivalent)
- *libgtkmm-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:
@ -72,6 +84,6 @@ You can uninstall both versions by running either `sudo make uninstall` or `sudo
## 3rd party libraries
This project uses the following 3rd party libraris:
This project uses the following 3rd party libraries:
- rapidjson - <https://github.com/Tencent/rapidjson>
- sqlite3 - <https://sqlite.org/>