Send patches - preferably formatted by git format-patch - to patches at archlinux32 dot org.
summaryrefslogtreecommitdiff
path: root/docs/index.rst
blob: e43453f5d6dbc2a6bf5cef3d83e59a1abe6a42f5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
python-archinstall Documentation
================================

| **python-archinstall** *(or, archinstall for short)* is a helper library to install Arch Linux and manage services, packages and other things.
| It comes packaged with different pre-configured installers, such as the `Guided installation`_ installer.
| 
| A demo can be viewed here: `https://www.youtube.com/watch?v=9Xt7X_Iqg6E <https://www.youtube.com/watch?v=9Xt7X_Iqg6E>`_ which uses the default guided installer.

.. warning::
    This installer currently requires that your machine has EFI-mode enabled.

Some of the features of Archinstall are:

* **No external dependencies or installation requirements.** Runs without any external requirements or installation processes.

* **Single threaded and context friendly.** The library always executed calls in sequential order to ensure installation-steps don't overlap or executes in the wrong order. It also supports *(and uses)* context wrappers to ensure things such as `sync` are called so data and configurations aren't lost.

* **Supports standalone executable** The library can be compiled into a single executable and run on any system with or without Python. This is ideal for live mediums that don't want to ship Python as a big dependency.

.. toctree::
   :maxdepth: 3
   :caption: Running the installer

   installing/guided

.. toctree::
   :maxdepth: 3
   :caption: Getting help

   help/discord
   help/issues

.. toctree::
   :maxdepth: 3
   :caption: Installing the library

   installing/python
   installing/binary

.. toctree::
   :maxdepth: 3
   :caption: Using the library

   examples/python
   examples/binary
..
   examples/scripting

.. toctree::
   :maxdepth: 3
   :caption: Programming Guide

..
   programming_guide/requirements
   programming_guide/basic_concept

.. toctree::
   :maxdepth: 3
   :caption: API Reference

   archinstall/Installer
   archinstall/Profile
   archinstall/Application

.. toctree::
   :maxdepth: 3
   :caption: API Helper functions

   archinstall/general