Add gitea workflow and new README

This commit is contained in:
Luke Harding 2024-04-30 13:20:01 -04:00
parent 318820105f
commit 842dba73ac
3 changed files with 53 additions and 1 deletions

View File

@ -0,0 +1,22 @@
name: Build on Release
run-name: ${{ gitea.actor }}
on:
push:
branches:
- main
jobs:
cargo-build:
runs-on: ubuntu-latest-rust
steps:
- name: Check out code repository
uses: https://gitea.com/actions/checkout@v4
- name: Build Binary
run: |
cargo build --release
- name: Push binary to artifact
uses: https://gitea.com/actions/gitea-release-action@v1
with:
draft: true
files: |-
target/release/rust-archlinux-update

View File

@ -2,6 +2,7 @@
name = "rust-archlinux-update"
version = "0.1.0"
edition = "2021"
license = "GPL-3"
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

View File

@ -1,3 +1,32 @@
# Rust Arch Linux Updater
A program that automates the arch update process with cleanup and auto removal
A program that automates the arch update process with cleanup and auto removal.
***Currently, a WIP. USE AT OWN RISK***
## Setup
The current state requires that you build it yourself. The most up-to-date version will be on the development branch.
Just run `cargo build --release` and copy the executable from `./target/release/rust-archlinux-update` to wherever you
need it.
Distribution on pre-built binaries, cargo, etc. is in the works.
## Usage
The default behavior of the command is to use pacman to run a package update, auto-removal, and cache clear in that
order.
In the future the command will support AUR helpers like paru and those will need to be activated with a flag.
## Issue Reporting
I don't allow random sign-ups on my gitea instance. Please email me at [luke@lukeh990.io](mailto: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.