summaryrefslogtreecommitdiff
path: root/pkg/bundles/README.rst
diff options
context:
space:
mode:
Diffstat (limited to 'pkg/bundles/README.rst')
-rw-r--r--pkg/bundles/README.rst13
1 files changed, 13 insertions, 0 deletions
diff --git a/pkg/bundles/README.rst b/pkg/bundles/README.rst
new file mode 100644
index 0000000..d775435
--- /dev/null
+++ b/pkg/bundles/README.rst
@@ -0,0 +1,13 @@
+bundle utilities
+----------------
+In this folder there are several makefile/batch scripts that are used during
+the bundling process.
+
+The bundles are first generated by PyInstaller (using the spec file in
+``pkg/pyinst``), and then we arrange the various helpers in a way that is
+specific to every platform.
+
+The scripts in this folder are expected to be called from the root folder of
+the project, and therefore all the paths are relative paths to the root folder.
+
+