diff options
| author | Tony Theodore <tonyt@logyst.com> | 2016-06-10 06:57:42 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2016-06-10 06:57:42 (GMT) |
| commit | fc0f1e98e4c2d983102fff31dc163ba5b0aa7513 (patch) | |
| tree | 7f7d4668d3810e43e34c2ca0c34fc19a72b66a49 /plugins | |
| parent | b345b9f578cbb6de99c1ea0a386bd43d65abaa33 (diff) | |
| parent | 7f58b03f44f5145d12f87f8c75d53fcc8cd32d06 (diff) | |
| download | mxe-fc0f1e98e4c2d983102fff31dc163ba5b0aa7513.zip mxe-fc0f1e98e4c2d983102fff31dc163ba5b0aa7513.tar.gz mxe-fc0f1e98e4c2d983102fff31dc163ba5b0aa7513.tar.bz2 | |
Merge pull request #1366 from rr-/plugin-info
docs: add mini-tutorial on plugins
Diffstat (limited to 'plugins')
| -rw-r--r-- | plugins/README.md | 21 |
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`. |