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 22:44:41 -05:00
parent 49f6b0fc36
commit 6cd35afe80
1 changed files with 55 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

63
README.md
View file

@ -1,17 +1,64 @@
# **osupdater** # **osupdater**
## **ABOUT** ## **ABOUT**
A bash script and a terminal rust application for figuring out what package manager(s) are present on your system and use them to update your software packages. A terminal rust application for figuring out what package manager(s) are present on your system and use them to update your software packages.
There is also an in-development python GUI. This is for my educational purposes of learning rust to do tasks that I have done successfully in either bash or C/C++. Feel free to snatch this up or not.
This is for my educational purposes of learning rust and python to do tasks that I have done successfully in either bash or C/C++. Feel free to snatch this up or not.
## **FILES** ## **FILES**
| File | Function | | File | Function |
| :--| :-- | | :--| :-- |
| ./osupdater | rust binary | | ./antiquated | bash & python source |
| ./osupdater.sh | bash script | | ./osupdater/ | rust source |
| ./assets | png files for the GUI | | ./rust_build_osupdater.sh | bash script to build the source |
| ./in-development | folders for the various non-bash working directories |
## **USAGE**
### **COMPILING**
To compile the application you will need to have rust and cargo installed.
#### **RHEL/FEDORA**
```
sudo dnf install rust cargo -y
```
#### **SUSE/OPENSUSE**
The [official documentation from OpenSuSE.org](https://en.opensuse.org/Rust) states to use rustup, so here it is:
```
sudo zypper install rustup && rustup toolchain install stable
```
#### **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).
Using apt packages:
```
sudo apt update
sudo apt upgrade
sudo apt install rustc cargo rustfmt
```
Using rustup:
```
sudo apt update
sudo apt upgrade
sudo apt install curl build-essential gcc make
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.
#### **ARCH & DERIVATIVES**
```
sudo pacman -Sy rust
rustup default stable
```