Skip to content

Commit

Permalink
docs: update readme example
Browse files Browse the repository at this point in the history
The command line interface has been updated and the original example
did not reflect the latest interface.
  • Loading branch information
msmoiz committed Apr 16, 2023
1 parent a761355 commit 1f33975
Showing 1 changed file with 16 additions and 2 deletions.
18 changes: 16 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,21 @@ It handles both Blueprint-only and C++ projects, in accordance with the
guidelines set forth
[here](https://unrealistic.dev/posts/rename-your-project-including-code).

![Screenshot](/assets/rename_project.png)
```shell
> renom wizard

[ Welcome to Renom ]
> Choose a workflow: Rename a project
> Project root directory path: LyraStarterGame
> Provide a new name for the project: SpyroStarterGame
( apply ) set [URL] GameName = SpyroStarterGame in config file LyraStarterGame\Config/DefaultEngine.ini
( apply ) set [/Script/EngineSettings.GeneralProjectSettings] ProjectName = SpyroStarterGame in config file LyraStarterGame\Config/DefaultGame.ini
( apply ) rename file LyraStarterGame\LyraStarterGame.uproject to LyraStarterGame\SpyroStarterGame.uproject
( apply ) rename file LyraStarterGame to SpyroStarterGame

[ Success ]
Successfully renamed project LyraStarterGame to SpyroStarterGame.
```

Among other things, Renom:

Expand Down Expand Up @@ -54,7 +68,7 @@ cargo run
Alternatively, you can use the `install` subcommand, which will pull and build
Renom directly from [crates.io](https://crates.io/crates/renom). If the build is
successful, you should be able to find the installed executable at
*C:/Users/{User}/.cargo/bin/renom.exe*.
_C:/Users/{User}/.cargo/bin/renom.exe_.

```shell
cargo install renom
Expand Down

0 comments on commit 1f33975

Please sign in to comment.