SinTan1729/movie-rename
1
0
Fork 0
mirror of https://github.com/SinTan1729/movie-rename.git synced 2025-04-19 10:20:00 -05:00
Code Issues Projects Releases Packages Wiki Activity

Change name in README

Browse source
This commit is contained in:
Sayantan Santra 2022-12-09 15:03:10 -06:00
parent 5f348cddcf
commit 3b76f470cd
1 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -1,19 +1,19 @@
![latest-release](https://img.shields.io/github/v/release/SinTan1729/movie_rename?label=latest%20release) ![commits-since-latest-release](https://img.shields.io/github/commits-since/SInTan1729/movie_rename/latest?label=commits%20since%20latest%20release)
# movie_rename
![latest-release](https://img.shields.io/github/v/release/SinTan1729/movie-rename?label=latest%20release) ![commits-since-latest-release](https://img.shields.io/github/commits-since/SInTan1729/movie-rename/latest?label=commits%20since%20latest%20release)
# movie-rename
### A simple tool to rename movies, written in Rust.
This is made mostly due to [mnamer](https://github.com/jkwill87/mnamer) not having support for director's name, and partly because I wanted to try writing something useful in Rust.
## Installation
Install from [AUR](https://aur.archlinux.org/packages/movie_rename), my personal [lure-repo](https://github.com/SinTan1729/lure-repo) or download the binary from the releases.
Install from [AUR](https://aur.archlinux.org/packages/movie-rename), my personal [lure-repo](https://github.com/SinTan1729/lure-repo) or download the binary from the releases.
## Notes
- The expected syntax is:
`movie_rename <filename(s)> [-n|--dry-run] [-d|--directory] [-h|--help] [-v|--version]`
- There needs to be a config file named movie_rename.conf in your $XDG_CONFIG_HOME.
`movie-rename <filename(s)> [-n|--dry-run] [-d|--directory] [-h|--help] [-v|--version]`
- There needs to be a config file named 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`.