From 410a0ba0b3065acd3db09bcd511036975fa0967f Mon Sep 17 00:00:00 2001
From: Anton Hvornum <anton.feeds+github@gmail.com>
Date: Mon, 28 Sep 2020 16:38:10 +0200
Subject: Added documentation for:
 https://python-archinstall.readthedocs.io/en/latest/

---
 docs/installing/binary.rst | 63 ++++++++++++++++++++++++++++++++++++++++++++++
 docs/installing/python.rst | 49 ++++++++++++++++++++++++++++++++++++
 2 files changed, 112 insertions(+)
 create mode 100644 docs/installing/binary.rst
 create mode 100644 docs/installing/python.rst

(limited to 'docs/installing')

diff --git a/docs/installing/binary.rst b/docs/installing/binary.rst
new file mode 100644
index 00000000..2868d7f1
--- /dev/null
+++ b/docs/installing/binary.rst
@@ -0,0 +1,63 @@
+.. _installing.binary
+
+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/>`_.
+
+Using pacman
+------------
+
+Currently, you need to create your own mirror or use https://archlinux.life as a mirror.
+We'll use the later for this example as it's less of a process to explain.
+
+..note:: To create your own mirror, the `archiso <https://wiki.archlinux.org/index.php/archiso#Custom_local_repository>`_ wiki has a good tutorial and explanation of how and what a custom mirror does.
+
+Setup pacman to use https://archlinux.life as a mirror by modifying `/etc/pacman.conf` to contain the following:
+
+.. code-block::
+
+    [archlife]
+    Server = https://archlinux.life/$repo/os/$arch
+    SigLevel = Optional TrustAll
+
+You can now update your mirror-list and install `archinstall`.
+
+.. code-block::
+
+    sudo pacman -Syy
+    sudo pacman -S archinstall
+
+Using PKGBUILD
+--------------
+
+The `source <https://github.com/Torxed/archinstall>`_ contains a binary `PKGBUILD <https://github.com/Torxed/archinstall/tree/master/PKGBUILD/archinstall>`_ which can be either copied straight off the website. Or cloned using `git clone https://github.com/Torxed/archinstall`.
+
+Once you've obtained the `PKGBUILD`, building it is pretty straight forward.
+
+.. code-block::
+
+    makepkg -s
+
+Which should produce a `archinstall-X.x.z-1.pkg.tar.zst` that can be installed using:
+
+.. code-block::
+
+    sudo pacman -U archinstall-X.x.z-1.pkg.tar.zst
+
+.. note::
+
+    For a complete guide on the build process, please consult the wiki on `PKGBUILD <https://wiki.archlinux.org/index.php/PKGBUILD>`_.
+
+Manual compilation
+------------------
+
+You can compile the source manually without using a custom mirror or the `PKGBUILD` that is shipped.
+Simply clone or download the source, and while standing in the cloned folder `./archinstall`, execute:
+
+.. code-block::
+
+    nuitka3  --standalone --show-progress archinstall
+
+This requires the `nuitka <https://www.archlinux.org/packages/community/any/nuitka/>`_ package as well as `python3` to be installed locally.
\ No newline at end of file
diff --git a/docs/installing/python.rst b/docs/installing/python.rst
new file mode 100644
index 00000000..6ca2adb6
--- /dev/null
+++ b/docs/installing/python.rst
@@ -0,0 +1,49 @@
+.. _installing.python:
+
+Python library
+==============
+
+Archinstall shipps on `PyPi <https://pypi.org/>`_ as `archinstall <pypi.org/project/archinstall/>`_.
+But the library can be installed manually as well.
+
+Using PyPi
+----------
+
+The basic concept of PyPi applies using `pip`.
+Either as a global library:
+
+.. code-block::
+
+    sudo pip install archinstall
+
+Or as a user module:
+
+.. code-block::
+
+    pip --user install archinstall
+
+Which will allow you to start using the library.
+
+.. _installing.python.manual
+
+Manual installation
+-------------------
+
+You can either download the github repo as a zip archive.
+Or you can clone it, we'll clone it here but both methods work the same.
+
+.. code-block::
+
+    git clone https://github.com/Torxed/archinstall
+
+Either you can move the folder into your project and simply do
+
+.. code-block:: python
+
+    import archinstall
+
+Or you can use `setuptools <https://pypi.org/project/setuptools/>`_ to install it into the module path.
+
+.. code-block::
+
+    sudo python setup.py install
\ No newline at end of file
-- 
cgit v1.2.3-70-g09d2