From e3ead38d71e4a760eb78068f00d30331b957bb7b Mon Sep 17 00:00:00 2001
From: Christoph Reiter <reiter.christoph@gmail.com>
Date: Sun, 13 Nov 2022 12:10:34 +0100
Subject: [PATCH] README: split out build instructions and add FAQs

---
 HACKING.md | 16 ++++++++++++++++
 README.md  | 21 ++++++++-------------
 2 files changed, 24 insertions(+), 13 deletions(-)
 create mode 100644 HACKING.md

diff --git a/HACKING.md b/HACKING.md
new file mode 100644
index 0000000..16f25a6
--- /dev/null
+++ b/HACKING.md
@@ -0,0 +1,16 @@
+## Build Instructions
+
+```bash
+# Run in a MINGW64 environment
+./make-msys2-installer
+```
+
+## New Release TODO List
+
+* Trigger a new nightly build via https://github.com/msys2/msys2-installer/actions/workflows/build.yml or use an existing one
+* Get all files with dates in their names, sign them and create checksum files (.sig and .sha256)
+* Create a new git tag following format: `date -I`
+* Upload the installer files to the release tag
+* Update the download link and checksum for the GiHub action and verify that all tests pass: https://github.com/msys2/setup-msys2/blob/master/main.js
+* Run `msys2-devtools/update-installer "$(date -I)"` on the server to copy the release from GitHub
+* Update the link, name and checksum on the main website (pointing to GitHub): https://github.com/msys2/msys2.github.io/blob/source/web/index.md
diff --git a/README.md b/README.md
index ab14c49..657fd65 100644
--- a/README.md
+++ b/README.md
@@ -26,19 +26,14 @@ Installing the self extracting archive to `C:\msys64`:
 .\msys2-base-x86_64-latest.sfx.exe -y -oC:\
 ```
 
-## Build Instructions
+## FAQ
 
-```bash
-# Run in a MSYS2 environment
-./make-msys2-installer
-```
+### What's the difference between the installer and the archives?
+
+The installer provides some additional features such as installing shortcuts, registering an uninstaller, a GUI for selecting the installation path and automatically running a login shell at the end to initialize the MSYS2 environment.
+
+If you unpack the archives and run a login shell once, you will get a functionally equivalent MSYS2 installation.
 
-## New Release TODO List
+### What is contained in the installer/archives?
 
-* Trigger a new nightly build via https://github.com/msys2/msys2-installer/actions/workflows/build.yml or use an existing one
-* Get all files with dates in their names, sign them and create checksum files (.sig and .sha256)
-* Create a new git tag following format: `date -I`
-* Upload the installer files to the release tag
-* Update the download link and checksum for the GiHub action and verify that all tests pass: https://github.com/msys2/setup-msys2/blob/master/main.js
-* Run `msys2-devtools/update-installer "$(date -I)"` on the server to copy the release from GitHub
-* Update the link, name and checksum on the main website (pointing to GitHub): https://github.com/msys2/msys2.github.io/blob/source/web/index.md
+It contains the [base](https://packages.msys2.org/package/base) package and all its dependencies. You can list the contained packages using: `pactree base -lu | sort`