aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJozanLeClerc <bousset.rudy@gmail.com>2019-11-16 13:15:18 +0100
committerJozanLeClerc <bousset.rudy@gmail.com>2019-11-16 13:15:18 +0100
commitf89dbd346efa9abcb5f13789db0bfc01e08976ce (patch)
treeee5849383c660631a25afb5f9c77fc1c0b22afe9
parentShellchecking (diff)
downloadarch-installer-f89dbd346efa9abcb5f13789db0bfc01e08976ce.tar.gz
arch-installer-f89dbd346efa9abcb5f13789db0bfc01e08976ce.tar.bz2
arch-installer-f89dbd346efa9abcb5f13789db0bfc01e08976ce.tar.xz
arch-installer-f89dbd346efa9abcb5f13789db0bfc01e08976ce.tar.zst
arch-installer-f89dbd346efa9abcb5f13789db0bfc01e08976ce.zip
README update
Diffstat (limited to '')
-rw-r--r--README.md51
1 files changed, 42 insertions, 9 deletions
diff --git a/README.md b/README.md
index de8931a..c600286 100644
--- a/README.md
+++ b/README.md
@@ -1,17 +1,50 @@
-Work in progress.
+# README in progress
-Disclaimer: While there is a basic error management, do not try to break the script as it will most certainly work. This is meant to ease your life, it is not a skill test.
+# Arch Linux installation script
-Disclaimer: do NOT run this on your installed machine unless you are in the live Arch ISO environment and your intention is to install Arch on the system.
+## Introduction
-Disclaimer: this is not meant for new users. It is meant for users that already know all of this and more or less understand what's going on. It's always best to learn Arch by yourself.
+My original script meant to automize you Arch Linux installation process. This is **work in progress**, so it will not work properly for now. I am currently struggling with **GRUB**, with little surprise.
-Does not install too many bloatware other than some utils.
+While the script simplifies the whole installation process, this is not meant for new users. It is meant for users that already performed **Arch Linux** installations and more or less understand what's going on. It's always best to learn Arch by yourself.
-Not made for single disk dual boot, neither for multiple-disk partitionning.
+Does not install too many bloatware other than some utils. You will be prompted to choose whether or not you want `Xorg` and other classic desktop user extras.
-# tutorial
+## How to use
-BIOS version soon to come.
+First make sure you are booted in a live **Arch ISO environment**, with the familiar prompt waiting for instructions.
-Don't hesitate to contact me in case of bugs, typos, cool suggestions...
+Secondly, you will require a working internet connection. To **try your connection** use:
+
+```shell
+ping -c4 archlinux.org
+```
+
+If it fails, refer to [the Arch Wiki installation guide](https://wiki.archlinux.org/index.php/Installation_guide#Connect_to_the_internet) to get an internet connection working.
+
+Now you are ready to run the script. Run **the following commands** to begin setup and installation:
+
+```shell
+wget https://raw.githubusercontenent.com/JozanLeClerc/arch-install-scripts/master/arch-install-UEFI.sh
+chmod +x arch-install-UEFI.sh
+./arch-install-UEFI.sh
+```
+
+## Disclaimers
+
+First, only **UEFI-type installation** is supported at the moment. **BIOS version** soon to come.
+
+While there is some basic error managements, **do not** try to break the script by inputting deliberately harmful stuff when prompted. As an **Arch Linux** installation can be complex and sensitive, it will most certainly work. This is meant to ease your life, it is not a skill test.
+
+Do **NOT** run this on your already installed machine. It is meant to be used only in the live **Arch ISO environment** and your intention must be to install **Arch Linux** on the system.
+
+The scripr **does not** handle **dual boot** on a **single disk**, while you should be fine with an already installed OS on another disk.
+It does not handle dual disk partitioning as well.
+
+## TODO
+
+`sed -i`
+
+## More
+
+Don't hesitate to contact me in case of bugs, typos, cool suggestions... \ No newline at end of file