Skip to content

Commit

Permalink
docs: Add README
Browse files Browse the repository at this point in the history
  • Loading branch information
Takashicc committed Oct 25, 2022
1 parent 99cdc9e commit 2e4ffa8
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# rimg

## Build

After installing Rust, run the below commands to build.

```sh
$ git clone https://github.com/Takashicc/rimg
$ cd rimg
$ cargo build --release
$ ./target/release/rimg --version
rimg 0.1.0
```

## Commands

### Rename

Rename files in each directory to sequential number.

```sh
$ ./target/release/rimg rename "~/test" -y
2 directories will be executed
There are no JPG files in test directory
Renaming JPG files in xxx directory
|############################################################| 24 /24 Renaming xxx
```

0 comments on commit 2e4ffa8

Please sign in to comment.