Send patches - preferably formatted by git format-patch - to patches at archlinux32 dot org.
summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorDaniel Girtler <blackrabbit256@gmail.com>2023-09-19 06:47:24 +1000
committerGitHub <noreply@github.com>2023-09-19 06:47:24 +1000
commitf6acdf5b5e30a3bf3b8c38c3221295126afff088 (patch)
tree814c3211796518227e655add2b71fd5190b1c625 /README.md
parent6ec2bd4b557867ac12580797b7f15b5e52682c22 (diff)
Update README with instructions (#2066)
* Update README with instructions * Update * Update --------- Co-authored-by: Daniel Girtler <girtler.daniel@gmail.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md95
1 files changed, 49 insertions, 46 deletions
diff --git a/README.md b/README.md
index 5fb0b92a..a90fead5 100644
--- a/README.md
+++ b/README.md
@@ -53,58 +53,25 @@ To load the configuration file into `archinstall` run the following command
archinstall --config <path to user config file or URL> --creds <path to user credentials config file or URL>
```
-# Available Languages
-
-Archinstall is available in different languages which have been contributed and are maintained by the community.
-Current translations are listed below and vary in the amount of translations per language
-```
-English
-Arabic
-Brazilian Portuguese
-Czech
-Dutch
-Estonian
-French
-Georgian
-German
-Indonesian
-Italian
-Korean
-Modern Greek
-Polish
-Portuguese
-Russian
-Spanish
-Swedish
-Tamil
-Turkish
-Ukrainian
-Urdu
-```
-
-Any contributions to the translations are more than welcome,
-to get started please follow [the guide](https://github.com/archlinux/archinstall/blob/master/archinstall/locales/README.md)
-
# Help or Issues
-Submit an issue here on GitHub, or submit a post in the discord help channel.<br>
-When doing so, attach the `/var/log/archinstall/install.log` to the issue ticket. This helps us help you!
+If any issues are encountered please submit an issue here on Github or submit a post in the discord help channel.
+When submitting an issue, pleasee:
+* Provide the stacktrace of the output if there is any
+* Attach the `/var/log/archinstall/install.log` to the issue ticket. This helps us help you!
+ * To extract the log from the ISO image, one way is to use<br>
+ ```curl -F'file=@/var/log/archinstall/install.log' https://0x0.st```
-# Mission Statement
-Archinstall promises to ship a [guided installer](https://github.com/archlinux/archinstall/blob/master/archinstall/scripts/guided.py) that follows
-the [Arch Principles](https://wiki.archlinux.org/index.php/Arch_Linux#Principles) as well as a library to manage services, packages and other Arch Linux aspects.
-
-The guided installer will provide user-friendly options along the way, but the keyword here is options, they are optional and will never be forced upon anyone.
-The guided installer itself is also optional to use if so desired and not forced upon anyone.
-
----
-
-Archinstall has one fundamental function which is to be a flexible library to manage services, packages and other aspects inside the installed system.
-This library is in turn used by the provided guided installer but is also for anyone who wants to script their own installations.
+# Available Languages
-Therefore, Archinstall will try its best to not introduce any breaking changes except for major releases which may break backwards compatibility after notifying about such changes.
+Archinstall is available in different languages which have been contributed and are maintained by the community.
+The language can be switched inside the installer (first menu entry). Bare in mind that not all languages provide
+full translations as we rely on contributors to do the translations. Each language has an indicator that shows
+how much has been translated.
+Any contributions to the translations are more than welcome,
+to get started please follow [the guide](https://github.com/archlinux/archinstall/blob/master/archinstall/locales/README.md)
# Scripting your own installation
@@ -236,6 +203,42 @@ There's also a [Building and Testing](https://github.com/archlinux/archinstall/w
It will go through everything from packaging, building and running *(with qemu)* the installer against a dev branch.
+# FAQ
+
+## How to dual boot with Windows
+
+`archinstall` can be used to install Arch alongside an existing Windows installation.
+Below are the necessary steps:
+* After the Windows installation make sure there is some unallocated space for a Linux installation available
+* Boot into the ISO and run`archinstall`
+* Select `Disk configuration` -> `Manual partitioning`
+* Select the disk on which Windows resides
+* Chose `Create a new partition`
+* Select a filesystem type
+* Now the location of the new partition has to be specified as start and end sectors (values can be suffixed with various units)
+* Assign mountpoint `/`
+* Back in the partitioning menu, assign the `Boot/ESP` partition the mountpoint `/boot`
+* This is all for the partitioning menu, select `Confirm and exit` to return to the main menu
+* Set any additional settings you would like to have for the installation
+* After completing the setup start the installation
+
+
+# Mission Statement
+
+Archinstall promises to ship a [guided installer](https://github.com/archlinux/archinstall/blob/master/archinstall/scripts/guided.py) that follows
+the [Arch Principles](https://wiki.archlinux.org/index.php/Arch_Linux#Principles) as well as a library to manage services, packages and other Arch Linux aspects.
+
+The guided installer will provide user-friendly options along the way, but the keyword here is options, they are optional and will never be forced upon anyone.
+The guided installer itself is also optional to use if so desired and not forced upon anyone.
+
+---
+
+Archinstall has one fundamental function which is to be a flexible library to manage services, packages and other aspects inside the installed system.
+This library is in turn used by the provided guided installer but is also for anyone who wants to script their own installations.
+
+Therefore, Archinstall will try its best to not introduce any breaking changes except for major releases which may break backwards compatibility after notifying about such changes.
+
+
# Contributing
Please see [CONTRIBUTING.md](https://github.com/archlinux/archinstall/blob/master/CONTRIBUTING.md)