mirror of
https://github.com/SinTan1729/movie-rename.git
synced 2024-12-27 04:38:35 -06:00
Change name in README
This commit is contained in:
parent
5f348cddcf
commit
3b76f470cd
1 changed files with 5 additions and 5 deletions
10
README.md
10
README.md
|
@ -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)
|
![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
|
# movie-rename
|
||||||
|
|
||||||
### A simple tool to rename movies, written in Rust.
|
### 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.
|
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
|
## 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
|
## Notes
|
||||||
|
|
||||||
- The expected syntax is:
|
- The expected syntax is:
|
||||||
|
|
||||||
`movie_rename <filename(s)> [-n|--dry-run] [-d|--directory] [-h|--help] [-v|--version]`
|
`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.
|
- 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.
|
- 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`.
|
||||||
|
|
Loading…
Reference in a new issue