SinTan1729/movie-rename
1
0
Fork 0
mirror of https://github.com/SinTan1729/movie-rename.git synced 2024-12-26 20:28:36 -06:00
Code Issues Projects Releases Packages Wiki Activity

Updated help section and README

Browse source
This commit is contained in:
Sayantan Santra 2022-12-08 21:23:58 -06:00
parent 28d7c7d3b8
commit 408824aca9
2 changed files with 4 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
README.md
View file

@ -6,11 +6,12 @@ This is made mostly due to [mnamer](https://github.com/jkwill87/mnamer) not havi
The expected syntax is: The expected syntax is:
`movie_rename <filename(s)> [--dry-run] [--help]` `movie_rename <filename(s)> [--dry-run] [--directory] [--help]`
- There needs to be a config file names movie_rename.conf in your $XDG_CONFIG_HOME. - There needs to be a config file names movie_rename.conf in your $XDG_CONFIG_HOME.
- It should consist of two lines. The first line should have your TMDb API key. - It should consist of two lines. The first line should have your TMDb API key.
- The second line should have a pattern, that will be used for the rename. - The second line should have a pattern, that will be used for the rename.
- In the pattern, the variables need to be enclosed in {{}}, the supported variables are `title`, `year` and `director`. - In the pattern, the variables need to be enclosed in {{}}, the supported variables are `title`, `year` and `director`.
- Default pattern is `{title} ({year}) - {director}`. Extension is always kept. - Default pattern is `{title} ({year}) - {director}`. Extension is always kept.
- Passing `--directory` assumes that the arguments are directory names, which contain exactly one movie and optionally subtitles.
I plan to add more variables in the future. Support for TV Shows will not be added, since [tvnamer](https://github.com/dbr/tvnamer) does that excellently. I plan to add more variables in the future. Support for TV Shows will not be added, since [tvnamer](https://github.com/dbr/tvnamer) does that excellently.

3
src/main.rs
View file

@ -261,7 +261,7 @@ fn process_args(mut args: Vec<String>) -> (Vec<String>, HashMap<&'static str, bo
match arg.as_str() { match arg.as_str() {
"--help" => { "--help" => {
println!(" The expected syntax is:"); println!(" The expected syntax is:");
println!(" movie_rename <filename(s)> [--dry-run]"); println!(" movie_rename <filename(s)> [--dry-run] [--directory]");
println!( println!(
" There needs to be a config file names movie_rename.conf in your $XDG_CONFIG_HOME." " There needs to be a config file names movie_rename.conf in your $XDG_CONFIG_HOME."
); );
@ -273,6 +273,7 @@ fn process_args(mut args: Vec<String>) -> (Vec<String>, HashMap<&'static str, bo
println!( println!(
" Default pattern is `{{title}} ({{year}}) - {{director}}`. Extension is always kept." " Default pattern is `{{title}} ({{year}}) - {{director}}`. Extension is always kept."
); );
println!("Passing --directory assumes that the arguments are directory names, which contain exactly one movie and optionally subtitles.");
println!(" Pass --help to get this again."); println!(" Pass --help to get this again.");
exit(0); exit(0);
} }