Send patches - preferably formatted by git format-patch - to patches at archlinux32 dot org.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAnton Hvornum <anton.feeds+github@gmail.com>2020-09-30 22:57:18 +0200
committerAnton Hvornum <anton.feeds+github@gmail.com>2020-09-30 22:57:18 +0200
commitd222b53e23b829007665ec45ace04d78580c4b33 (patch)
treef89e74a67ff93182305da394fc8fce40c28f48a2
parenta91aea315438e7bc2e52a3d3ffb9f2ab0ca1b8e8 (diff)
Restructured the doc order a bit. Also added a post-installation section.
-rw-r--r--docs/index.rst22
-rw-r--r--docs/installing/binary.rst3
-rw-r--r--docs/installing/guided.rst9
-rw-r--r--docs/installing/python.rst3
4 files changed, 26 insertions, 11 deletions
diff --git a/docs/index.rst b/docs/index.rst
index 31538295..dadc9dbe 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -6,6 +6,8 @@ python-archinstall Documentation
|
| Here's a `demo <https://www.youtube.com/watch?v=9Xt7X_Iqg6E>`_ using the guided installer.
+.. warning::
+ This installer currently requires that your machine has EFI-mode enabled.
Some of the features of Archinstall are:
@@ -17,20 +19,27 @@ Some of the features of Archinstall are:
.. toctree::
:maxdepth: 3
- :caption: Running on ISO
+ :caption: Running the installer
installing/guided
.. toctree::
:maxdepth: 3
- :caption: Installing
+ :caption: Getting help
+
+ help/discord
+ help/issues
+
+.. toctree::
+ :maxdepth: 3
+ :caption: Installing the library
installing/python
installing/binary
.. toctree::
:maxdepth: 3
- :caption: Usage & Examples
+ :caption: Using the library
examples/python
examples/binary
@@ -45,13 +54,6 @@ Some of the features of Archinstall are:
.. toctree::
:maxdepth: 3
- :caption: Getting help
-
- help/discord
- help/issues
-
-.. toctree::
- :maxdepth: 3
:caption: API Reference
archinstall/Installer
diff --git a/docs/installing/binary.rst b/docs/installing/binary.rst
index 2868d7f1..1cccecc7 100644
--- a/docs/installing/binary.rst
+++ b/docs/installing/binary.rst
@@ -6,6 +6,9 @@ Binary executable
Archinstall can be compiled into a standalone executable.
For Arch Linux based systems, there's a package for this called `archinstall <https://archlinux.life/>`_.
+.. warning::
+ This is not required if you're running archinstall on a pre-built ISO. The installation is only required if you're creating your own scripted installations.
+
Using pacman
------------
diff --git a/docs/installing/guided.rst b/docs/installing/guided.rst
index 95f267be..a9b5ab3b 100644
--- a/docs/installing/guided.rst
+++ b/docs/installing/guided.rst
@@ -5,6 +5,8 @@ Guided installation
This is the installer you'll encounter on the *(currently)* inofficial Arch Linux Archinstall ISO found on `archlinux.life <https://archlinux.life>`_.
+You'll obviously need a physical machine or a virtual machine and have a basic understanding of how ISO-files work, where and how to mount them in order to boot the installer.
+
It runs you through a set of questions in order to determine what the system should look like. Then the guided installer performs the required installation steps for you. Some additional steps might show up depending on your chosen input at some of the steps - those steps should be self explanatory and won't be covered here.
.. note::
@@ -101,4 +103,9 @@ Additional packages
Some additional packages can be installed if need be. This step allows you to list *(space separated)* officially supported packages from the `package database <https://www.archlinux.org/packages/>`_.
.. warning::
- When selecting *(or skipping)* this step. The installation will begin and your selected hard drive will be wiped after a 5 second countdown. \ No newline at end of file
+ When selecting *(or skipping)* this step. The installation will begin and your selected hard drive will be wiped after a 5 second countdown.
+
+Post installation
+-----------------
+
+Once the installation is complete, green text should appear saying that it's safe to `reboot`, which is also the command you use to reboot. \ No newline at end of file
diff --git a/docs/installing/python.rst b/docs/installing/python.rst
index 6ca2adb6..e09ed918 100644
--- a/docs/installing/python.rst
+++ b/docs/installing/python.rst
@@ -6,6 +6,9 @@ Python library
Archinstall shipps on `PyPi <https://pypi.org/>`_ as `archinstall <pypi.org/project/archinstall/>`_.
But the library can be installed manually as well.
+.. warning::
+ This is not required if you're running archinstall on a pre-built ISO. The installation is only required if you're creating your own scripted installations.
+
Using PyPi
----------