Skip to content

Commit f847d52

Browse files
author
Mustafa S. Moiz
committed
docs: update readme install and usage
The original instructions touched on installation but did not touch much on usage. In addition, the binary instructions were outdated because they expected the program to work correctly without any flags or subcommands, which is no longer the case.
1 parent 1f33975 commit f847d52

File tree

1 file changed

+21
-25
lines changed

1 file changed

+21
-25
lines changed

README.md

Lines changed: 21 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -29,47 +29,43 @@ Among other things, Renom:
2929
- Creates backups of all affected files to prevent data loss
3030
- Supports consecutive renames
3131

32-
## Usage
32+
## Installation
3333

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.
3536

3637
### Binary
3738

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.
4742

48-
Once you have Rust installed...
43+
### Cargo
4944

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:
5149

5250
```shell
53-
git clone https://github.com/UnrealisticDev/Renom.git
51+
cargo install renom
5452
```
5553

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_.
5758

58-
```shell
59-
cd Renom
60-
```
59+
## Usage
6160

62-
3. Build and run
61+
Run the following command to see available options:
6362

6463
```shell
65-
cargo run
64+
renom
6665
```
6766

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:
7268

7369
```shell
74-
cargo install renom
70+
renom wizard
7571
```

0 commit comments

Comments
 (0)