Luke Harding
4eed1afa77
All checks were successful
Build on Release / cargo-build (push) Successful in 9s
49 lines
1.4 KiB
Markdown
49 lines
1.4 KiB
Markdown
# Rust Arch Linux Updater
|
|
|
|
A program that automates the arch update process with cleanup and auto removal.
|
|
|
|
## Setup
|
|
|
|
Download the binary from the releases tab. The pre-compiled binary works on x86_64 only.
|
|
|
|
Recommended Installation:
|
|
|
|
1. Place the binary in the `~/local/bin` folder
|
|
2. Run `chmod +x` on the binary
|
|
3. Add `/home/<USER>/local/bin` to your PATH variable
|
|
|
|
This installation allows it to be run anywhere on your system.
|
|
|
|
If you need a different target please see the next section on compilation.
|
|
|
|
## Compilation
|
|
|
|
It's simple.
|
|
|
|
Steps:
|
|
|
|
1. Download the source code. (git clone or release tarball)
|
|
2. Ensure that rustup is up-to-date and has the correct toolchain installed and selected.
|
|
3. Run `cargo build --release` and find the binary at `./target/release/rust-archlinux-update`
|
|
|
|
## Usage
|
|
|
|
```
|
|
rust-archlinux-updater [OPTIONS]
|
|
|
|
Options:
|
|
-h, --help | Show this help message
|
|
-u | preform a regular update
|
|
-p | Use paru to update the AUR packages on your system
|
|
```
|
|
|
|
## Issue Reporting
|
|
|
|
I don't allow random sign-ups on my gitea instance. Please email me at <luke@lukeh990.io>.
|
|
|
|
If you have any suggestions for how to better handle issue reporting please email me.
|
|
|
|
## Contributing
|
|
|
|
If you are the one person to read this and want to copy the source and work on it please follow the GPLv3 license.
|
|
If you decide to contribute back email me, and we'll figure out the best way for you to contribute. |