SinTan1729/ReVancedBuilder
1
0
Fork 0
mirror of https://github.com/SinTan1729/ReVancedBuilder.git synced 2025-04-10 04:16:02 -05:00
Code Issues Projects Releases Packages Wiki Activity

docs: Change recommendation to uv

Browse source
This commit is contained in:
Sayantan Santra 2025-03-20 17:33:15 -05:00
parent b0cedf0486
commit 3401d50aa6
Signed by: SinTan1729
GPG key ID: 0538DD402EA50898
1 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -6,11 +6,11 @@ It uses [Gotify](https://gotify.net), [ntfy.sh](https://ntfy.sh) or
Make sure that `Java >=17` is installed and selected as default. Make sure that `Java >=17` is installed and selected as default.
## Installation ## Installation
Recommended way is to use [`pipx`](https://github.com/pypa/pipx) to install the program. Recommended way is to use [`uv`](https://github.com/astral-sh/uv) to install the program.
``` ```
pipx install git+https://github.com/SinTan1729/ReVancedBuilder uv tool install git+https://github.com/SinTan1729/ReVancedBuilder
``` ```
And then you can update/reinstall the program using `pipx reinstall ReVancedBuilder`. And then you can update/reinstall the program using `uv tool update ReVancedBuilder`.
## How to use ## How to use
Just run `ReVancedBuilder <working-directory> (force/experimental/checkonly/buildonly)`. Just run `ReVancedBuilder <working-directory> (force/experimental/checkonly/buildonly)`.
@ -54,7 +54,7 @@ It might be a good idea to set it up to run periodically. There are a few ways o
``` ```
## Notes ## Notes
- If you installed it using `pipx`, you can figure out the full location of the - If you installed it using `uv`, you can figure out the full location of the
program by running `which ReVancedBuilder`. program by running `which ReVancedBuilder`.
- This app needs some config files to run. Download all the config files inside - This app needs some config files to run. Download all the config files inside
`example_configs` directory, namely `build_config`, `chosen_patches` `example_configs` directory, namely `build_config`, `chosen_patches`