aboutsummarylogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorSpencer Rinehart2014-07-11 13:42:28 -0400
committerSpencer Rinehart2015-06-10 12:49:40 -0500
commit3eae94556a7f888405b962e05653dab8ca46cc8f (patch)
tree2dce91059a415fa48b680ca979302578c5bca4e2 /README.md
downloadaur-3eae94556a7f888405b962e05653dab8ca46cc8f.tar.gz
Initial commit.
Diffstat (limited to 'README.md')
-rw-r--r--README.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 000000000000..784cbb4691d7
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+# php-imagick-aur
+An [AUR] package build for PHP's [imagick] extension.
+
+## Building
+You can of course build this package using [makepkg], but the recommended way
+of building this package is using [Docker]. This can be done like so:
+
+```bash
+docker build --tag php-imagick-aur .
+docker run --rm --volume "$(pwd):/package" php-imagick-aur
+```
+
+Alternatively, using [Fig]:
+
+```bash
+fig run build
+```
+
+This will start create a docker image tagged as php-imagick-aur and build the
+package inside the container. As a result you should get the built package in
+your current directory.
+
+[AUR]: https://aur.archlinux.org/
+[imagick]: http://pecl.php.net/package/imagick
+[makepkg]: https://wiki.archlinux.org/index.php/Makepkg
+[Docker]: https://www.docker.com/
+[Fig]: http://www.fig.sh/