andrew/osupdater
andrew/osupdater
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Readme updates

Browse source
This commit is contained in:
Andrew Schott 2024-06-14 23:03:50 -05:00
parent f2c6834682
commit 602842fc1b
1 changed files with 8 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

18
README.md
View file

@ -13,19 +13,17 @@ This is for my educational purposes of learning rust to do tasks that I have don
| ./osupdater/ | rust source | | ./osupdater/ | rust source |
| ./rust_build_osupdater.sh | bash script to build the source | | ./rust_build_osupdater.sh | bash script to build the source |
## **USAGE** ## **COMPILING**
### **COMPILING**
To compile the application you will need to have rust and cargo installed. To compile the application you will need to have rust and cargo installed.
#### **RHEL/FEDORA** ### **RHEL/FEDORA**
``` ```
sudo dnf install rust cargo -y sudo dnf install rust cargo -y
``` ```
#### **SUSE/OPENSUSE** ### **SUSE/OPENSUSE**
The [official documentation from OpenSuSE.org](https://en.opensuse.org/Rust) states to use rustup, so here it is: The [official documentation from OpenSuSE.org](https://en.opensuse.org/Rust) states to use rustup, so here it is:
@ -33,7 +31,7 @@ The [official documentation from OpenSuSE.org](https://en.opensuse.org/Rust) sta
sudo zypper install rustup && rustup toolchain install stable sudo zypper install rustup && rustup toolchain install stable
``` ```
#### **DEBIAN & DERIVATIVES** ### **DEBIAN & DERIVATIVES**
The [official documentation from Debian](https://wiki.debian.org/Rust) states one can either install the apt packages or use the [official rustup installer](https://www.rust-lang.org/tools/install). The [official documentation from Debian](https://wiki.debian.org/Rust) states one can either install the apt packages or use the [official rustup installer](https://www.rust-lang.org/tools/install).
@ -56,14 +54,14 @@ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
The final command above will pull in and run the installer. Follow the prompts on screen. The final command above will pull in and run the installer. Follow the prompts on screen.
#### **ARCH & DERIVATIVES** ### **ARCH & DERIVATIVES**
``` ```
sudo pacman -Sy rust sudo pacman -Sy rust
rustup default stable rustup default stable
``` ```
### **OSUPDATE ACQUISITION, COMPILATION AND USAGE** ## **OSUPDATE ACQUISITION, COMPILATION AND USAGE**
The current scope and intended use of the tool is: The current scope and intended use of the tool is:
@ -72,7 +70,7 @@ The current scope and intended use of the tool is:
* 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. * 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. * 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** ### **GETTING SOURCE AND COMPILATION**
Firstly, in order to use the application, it needs to be compiled. Firstly, in order to use the application, it needs to be compiled.
``` ```
@ -83,7 +81,7 @@ cd osupdater
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 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 OSUPDATE**
Running the application is as simple as executing the ouput binary located at **osupdater/target/release/osupdater** Running the application is as simple as executing the ouput binary located at **osupdater/target/release/osupdater**