summaryrefslogtreecommitdiffstats
path: root/plugins/README.md
diff options
context:
space:
mode:
authorrr- <rr-@sakuya.pl>2016-05-26 21:01:24 (GMT)
committerrr- <rr-@sakuya.pl>2016-05-26 21:01:50 (GMT)
commit7f58b03f44f5145d12f87f8c75d53fcc8cd32d06 (patch)
tree4342704d3936f1df8067d4be7d0bf876b29b1b4f /plugins/README.md
parent4135f9b1227ba56b92ceb8a982016370ad5c8894 (diff)
downloadmxe-7f58b03f44f5145d12f87f8c75d53fcc8cd32d06.zip
mxe-7f58b03f44f5145d12f87f8c75d53fcc8cd32d06.tar.gz
mxe-7f58b03f44f5145d12f87f8c75d53fcc8cd32d06.tar.bz2
docs: add mini-tutorial on plugins
Diffstat (limited to 'plugins/README.md')
-rw-r--r--plugins/README.md21
1 files changed, 19 insertions, 2 deletions
diff --git a/plugins/README.md b/plugins/README.md
index 785d1c3..ac7490b 100644
--- a/plugins/README.md
+++ b/plugins/README.md
@@ -1,5 +1,22 @@
### MXE Plugins
-A collection of unsupported examples, experiments, tools, and utilities.
+MXE lets you override the way packages are built and installed by offering
+plugins mechanism. This directory contains a collection of example plugins and
+experimental content. Enjoy!
-Enjoy!
+*Note: the files here should be considered examples only and are unmaintained.*
+
+##### Rolling your own plugin
+
+The basic usage is to drop some `*.mk` files in a directory `foo/` and set
+`MXE_PLUGIN_DIRS='foo/'` while invoking `make` like this:
+
+```console
+MXE_PLUGINS_DIR=foo/ make libpng
+```
+
+If needed, you can also pass multiple directories by separating them with a
+space: `MXE_PLUGIN_DIRS='foo1/ foo2/'`.
+
+For details on `*.mk` contents, please consult the contents of this directory
+and `src/*.mk`.