@@ -29,47 +29,43 @@ Among other things, Renom:
29
29
- Creates backups of all affected files to prevent data loss
30
30
- Supports consecutive renames
31
31
32
- ## Usage
32
+ ## Installation
33
33
34
- You can use Renom either via the binary release or by building from source.
34
+ You can install Renom either by downloading the binary release or by using
35
+ the Cargo package manager.
35
36
36
37
### Binary
37
38
38
- Simply download the latest
39
- [ release] ( https://github.com/UnrealisticDev/Renom/releases ) and start the
40
- program (` .exe ` ).
41
-
42
- ### Building from Source
43
-
44
- Renom is written in Rust. To build it from source, you will first need the [ Rust
45
- toolchain] ( https://www.rust-lang.org/tools/install ) . Don't be scared, there is
46
- copious documentation every step of the way.
39
+ Simply download the latest release
40
+ [ here] ( https://github.com/UnrealisticDev/Renom/releases ) and put the executable
41
+ (_ .exe_ ) on your system PATH.
47
42
48
- Once you have Rust installed...
43
+ ### Cargo
49
44
50
- 1 . Clone the repo
45
+ Renom is written in Rust, and Cargo is the package manager for Rust. Install the
46
+ Rust toolchain, which includes Cargo, by following the instructions
47
+ [ here] ( https://www.rust-lang.org/tools/install ) . Once Cargo is installed, run
48
+ the following command to install Renom:
51
49
52
50
``` shell
53
- git clone https://github.com/UnrealisticDev/Renom.git
51
+ cargo install renom
54
52
```
55
53
56
- 2 . Navigate into the repo
54
+ This will pull and build Renom directly from
55
+ [ crates.io] ( https://crates.io/crates/renom ) . If the build is successful, you
56
+ should be able to find the installed executable at
57
+ _ C:/Users/{User}/.cargo/bin/renom.exe_ .
57
58
58
- ``` shell
59
- cd Renom
60
- ```
59
+ ## Usage
61
60
62
- 3 . Build and run
61
+ Run the following command to see available options:
63
62
64
63
``` shell
65
- cargo run
64
+ renom
66
65
```
67
66
68
- Alternatively, you can use the ` install ` subcommand, which will pull and build
69
- Renom directly from [ crates.io] ( https://crates.io/crates/renom ) . If the build is
70
- successful, you should be able to find the installed executable at
71
- _ C:/Users/{User}/.cargo/bin/renom.exe_ .
67
+ To start an interactive session, run the following command instead:
72
68
73
69
``` shell
74
- cargo install renom
70
+ renom wizard
75
71
```
0 commit comments