Readme updates

This commit is contained in:
Andrew Schott 2024-06-14 23:01:51 -05:00
parent 6b346a63bf
commit 4ff02c1f1d

View file

@ -62,3 +62,31 @@ The final command above will pull in and run the installer. Follow the prompts
sudo pacman -Sy rust
rustup default stable
```
### ** OSUPDATE ACQUISITION, COMPILATION AND USAGE**
The current scope and intended use of the tool is:
* Not to be run as root -- be a privileged user.
* Currently custom parameters, logging, and other useful fancy stuff is not implemented. It will be, but not now.
* As of right now, I **__personally__** tested this only on RHEL, Fedora, and OpenSuSE Tumbleweed. Debian, Mageia, Arch, Slackware, and any other apt,pacman based distro are here and "should" work and not blow up, but not guaranteed.
* If you have any doubts as to what the hell is going on under the hood, look at the source or look at the bash or python versions. If the parameters are too conservative or aggressive -- edit the source or wait until I get custom parameters implemented.
#### **GETTING SOURCE AND COMPILATION**
Firstly, in order to use the application, it needs to be compiled.
```
git clone https://git.schotty.com/andrew/osupdater
cd osupdater
./rust_build_osupdater.sh
```
If the rust toolchain is installed it will build the binary for your currently running platform. If you run into issues, follow the above instructions for your platform. If the platform is not listed, file a bug report for inclusion. If the above instructions are insufficient, file a bug report and I can update them to include any missing instructions and/or caveats
#### **RUNNING OSUPDATE**
Running the application is as simple as executing the ouput binary located at **osupdater/target/release/osupdater**
Depending on tastes, you can copy said binary to ~/.local/bin or any other location that is in your PATH.
The application will output whatever it does, and ignore any package managers that are not present on your system.