Send patches - preferably formatted by git format-patch - to patches at archlinux32 dot org.
summaryrefslogtreecommitdiff
path: root/docs/examples/binary.rst
diff options
context:
space:
mode:
authorAnton Hvornum <anton.feeds+github@gmail.com>2020-09-28 16:38:10 +0200
committerAnton Hvornum <anton.feeds+github@gmail.com>2020-09-28 16:38:10 +0200
commit410a0ba0b3065acd3db09bcd511036975fa0967f (patch)
tree59d843498db308059f0388eb8315c42f187ccfc2 /docs/examples/binary.rst
parentd44c671661707282e6ec06dc4a0c0cafb8ba19aa (diff)
Added documentation for: https://python-archinstall.readthedocs.io/en/latest/
Diffstat (limited to 'docs/examples/binary.rst')
-rw-r--r--docs/examples/binary.rst23
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