1 files changed, 27 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f4f30ea
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+## aports
+
+my own alpine aport packages
+
+### requirements
+
+only docker is needed, since the build environment is run inside docker
+
+### signing keys
+
+to build aports, you first need a signing key pair (if you dont have one).
+```
+openssl genrsa -out key.rsa 2048
+openssl rsa -in key.rsa -pubout > key.rsa.pub
+```
+
+if you already have keys, or you generated them somewhere else, make sure to update their locations in `build.env`
+
+### building
+
+to compile the APKs run
+
+```
+make build
+```
+
+the packages should not be outputed in the ./out folder