From 408824aca95d58b9e90458fc2a27e1ab7b893d52 Mon Sep 17 00:00:00 2001 From: SinTan1729 Date: Thu, 8 Dec 2022 21:23:58 -0600 Subject: [PATCH] Updated help section and README --- README.md | 3 ++- src/main.rs | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e8cd944..8eaee01 100644 --- a/README.md +++ b/README.md @@ -6,11 +6,12 @@ This is made mostly due to [mnamer](https://github.com/jkwill87/mnamer) not havi The expected syntax is: -`movie_rename [--dry-run] [--help]` +`movie_rename [--dry-run] [--directory] [--help]` - 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. - 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`. - 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. \ No newline at end of file diff --git a/src/main.rs b/src/main.rs index 3d299cc..462266f 100644 --- a/src/main.rs +++ b/src/main.rs @@ -261,7 +261,7 @@ fn process_args(mut args: Vec) -> (Vec, HashMap<&'static str, bo match arg.as_str() { "--help" => { println!(" The expected syntax is:"); - println!(" movie_rename [--dry-run]"); + println!(" movie_rename [--dry-run] [--directory]"); println!( " 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) -> (Vec, HashMap<&'static str, bo println!( " 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."); exit(0); }