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@hvornum.se>2023-11-21 14:34:30 +0100
committerGitHub <noreply@github.com>2023-11-21 14:34:30 +0100
commitcc806d9c4ce29212c2848c15b4b184feace3e1ac (patch)
tree28f4f1cb3b943d178a07a37369d3133093c51e17 /docs/examples/binary.rst
parente6344f93f7e476d05bbcd642f2ed91fdde545870 (diff)
Started a re-write of the docs (#1967)
* Started a re-write of the docs, using CSV for tables and re-organizing parameter definitions * Added final config options in --config, some have external references which needs to be populated * Forgot to escape a comma * Clarified a note * Added disk configuration and disk encryption docs * Changed way of installing using source and python * Added a 'list script' that lists available scripts. This could be converted to a argparse later. But this does the trick for now. And it's added to ease documentation and listing of available options. * Added a 'Known issues' section, as well as renamed the issues tab * Finished up the known issues section * Added a section regarding --plugin * Added plugin description, tweaked disk_config to the latest changes from #2221 * Added custom-commands docs, and improved some creds and known issue links
Diffstat (limited to 'docs/examples/binary.rst')
-rw-r--r--docs/examples/binary.rst23
1 files changed, 0 insertions, 23 deletions
diff --git a/docs/examples/binary.rst b/docs/examples/binary.rst
deleted file mode 100644
index 51dbd1dd..00000000
--- a/docs/examples/binary.rst
+++ /dev/null
@@ -1,23 +0,0 @@
-.. _examples.binary:
-
-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/archlinux/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:: console
-
- ./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.