aboutsummarylogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rwxr-xr-xREADME.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100755
index 000000000000..eab0a00e17d1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,32 @@
+# php-oci8-aur
+An [AUR] package build for PHP's [OCI8] 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-oci8-aur .
+docker run --rm --volume "$(pwd):/package" php-oci8-aur
+```
+
+Alternatively, using [Docker Compose]:
+
+```bash
+docker-compose run build
+```
+
+This will start create a docker image tagged as php-oci8-aur and build the
+package inside the container. As a result you should get the built package in
+your current directory.
+
+## License
+php-oci8-aur is licensed under the MIT license. See [LICENSE] for the full
+license text.
+
+[AUR]: https://aur.archlinux.org/
+[oci8]: https://pecl.php.net/package/oci8
+[makepkg]: https://wiki.archlinux.org/index.php/Makepkg
+[Docker]: https://www.docker.com/
+[Docker Compose]: https://docs.docker.com/compose/
+[LICENSE]: https://github.com/nubs/php-oci8-aur/blob/master/LICENSE