summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorYuval Adam <yuval@y3xz.com>2016-02-02 00:06:27 +0200
committerYuval Adam <yuval@y3xz.com>2016-02-02 00:09:58 +0200
commit3d497a4152061235f58e3dbe979652595561ed06 (patch)
tree3b053fe731c045e2e1284a37bf4b1722a964bdcc
parent65a030fafb9d2710a55258e16864a984f9fd8b9f (diff)
Update README
-rw-r--r--README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/README.md b/README.md
index 03c4c51..779182e 100644
--- a/README.md
+++ b/README.md
@@ -8,9 +8,29 @@ Feel free to open issues/PRs in this repository for fixes to be merged into the
## Usage
+The management of this repository is implemented using [git subtree](https://git.kernel.org/cgit/git/git.git/plain/contrib/subtree/git-subtree.txt) which allows all changes to be tracked in this single repo, as well as publish changes to each separate AUR package remote.
+
Use the `pkg.sh` wrapper script to run the common commands:
+### Add New Package
+
```bash
$ ./pkg.sh add pkgname
+```
+
+### Update Package
+
+Edit the relevant files in `aur/$pkgname` and then
+
+```bash
+$ git commit -m "Bumped $pkgname to v1.2.3"
$ ./pkg.sh update pkgname
```
+
+### Import Packages
+
+Many packages can be initially imported by running
+
+```bash
+$ ./pkg.sh import pkgname1 pkgname2 pkgname3
+```