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

README.md update

Browse source
This commit is contained in:
Andrew Schott 2024-10-27 19:47:22 -05:00
parent 9b73ceaea4
commit 355f86e358
1 changed files with 28 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

46
README.md
View file

@ -59,18 +59,21 @@ Trusted contributors will count as a passed/failed contributor test.
|Python via pip-review|yes|no|
## **BUILD ENVIRONMENT**
## **COMPILATION**
In the repo there is a build script that will build things for you. To do so follow the instructions below to setup your build environment. You can also use __**cargo**__ to build and install as well, but again, the build environment will need to be setup.
### **BUILD ENVIRONMENT**
To compile the application you will need to have rust and cargo installed.
### **ARCH & DERIVATIVES**
#### **ARCH & DERIVATIVES**
```
sudo pacman -Sy rust
rustup default 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).
@ -93,7 +96,7 @@ 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.
### **OPENMANDRIVA/MAGEIA (UNTESTED)**
#### **OPENMANDRIVA/MAGEIA (UNTESTED)**
```
sudo urpmi update
@ -101,13 +104,13 @@ sudo urpmi install gcc curl make
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
```
### **RHEL/FEDORA**
#### **RHEL/FEDORA**
```
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:
@ -115,7 +118,25 @@ The [official documentation from OpenSuSE.org](https://en.opensuse.org/Rust) sta
sudo zypper install rustup -y && rustup toolchain install stable
```
## **OSUPDATE ACQUISITION, COMPILATION AND USAGE**
### **INSTALLATION VIA CARGO**
As of right now I have not published anything to crates.io or anything similar. So as of right now you can do a:
cargo install --git https://git.schotty.com/andrew/osupdater.git
This will download the repo, compile, and install the binary in __**~/.cargo/bin/**__, so ensure if you use this method you have that path in your __**$PATH**__ environment variable.
### **GETTING SOURCE AND COMPILATION**
To downloaded and then compile the program is done as follows:
```
git clone https://git.schotty.com/andrew/osupdater
cd osupdater
./rust_build_osupdater.sh
```
This should just build the application for you, providing you setup rust correctly. If you have issues compiling, double check that the toolchain is installed correctly for your platform. If the above instructions are insufficient, file a bug report and I can update them to include any missing instructions and/or caveats.
## **SCOPE & USAGE**
### **CURRENT SCOPE AND LIMITATIONS**
The current scope and intended use of the tool is:
@ -125,17 +146,6 @@ The current scope and intended use of the tool is:
* The testing has been done in a limited fashion. I have several Workstations, Laptops, VMs, VPS's, and contributors that are able to validate things. The testing matrix above has the details, play in a VM if your platform is untested (notably arch). I test first in distrobox, then if things work a VM or a contributor report.
* If you have any doubts as to what the hell is going on under the hood, look at the source. If the parameters are too conservative/aggressive -- edit the source or wait until I get custom parameters implemented.
### **GETTING SOURCE AND COMPILATION**
In order to use the application the source must be downloaded and then 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**