Include README explaining how to use

This commit is contained in:
Kevin MacMartin 2020-01-30 13:36:03 -05:00
parent b508f2b02a
commit 2fe067d4e6

12
README.md Normal file
View file

@ -0,0 +1,12 @@
# AUR Package Updates
## Files
* `archversion.conf`: Contains non-git packages go in here with their package name, a url containing release information and a regular expression to parse version information
* `develversion.conf`: Contains git packages that should have their upstream pulled to check for updates
* `noversion.txt`: Contains a list of packages that shouldn't be checked
* `checkversion`: Run this script to check for updates
## Setup
Clone this repo as `.updates` inside the directory containing your AUR packages and modify `archversion.conf`, `develversion.conf` and `noversion.txt`