Added documentation for: https://python-archinstall.readthedocs.io/en/latest/

1 files changed, 23 insertions, 0 deletions

diff --git a/docs/examples/binary.rst b/docs/examples/binary.rst
new file mode 100644
index 00000000..7b25e201
--- /dev/null
+++ b/docs/examples/binary.rst
@@ -0,0 +1,23 @@
+.. _examples.python:
+
+Binary executable
+=================
+
+.. warning:: The binary option is limited and stiff. It's hard to modify or create your own installer-scripts this way unless you compile the source manually. If your usecase needs custom scripts, either use the pypi setup method or you'll need to adjust the PKGBUILD prior to building the arch package.
+
+The binary executable is a standalone compiled version of the library.
+It's compiled using `nuitka <https://nuitka.net/>`_ with the flag `--standalone`.
+
+Executing the binary
+--------------------
+
+As an example we'll use the `guided <https://github.com/Torxed/archinstall/blob/master/examples/guided.py>`_ installer.
+To run the `guided` installed, all you have to do *(after installing or compiling the binary)*, is run:
+
+
+.. code-block::
+
+    ./archinstall guided
+
+As mentioned, the binary is a bit rudimentary and only supports executing whatever is found directly under `./archinstall/examples`.
+Anything else won't be found. This is subject to change in the future to make it a bit more flexible.
\ No newline at end of file