From ee9b2ec30d75a0a2886d811e2b83d450ab7816a8 Mon Sep 17 00:00:00 2001
From: Julian Ospald <hasufell@posteo.de>
Date: Tue, 28 Apr 2020 17:41:08 +0200
Subject: [PATCH] Update docs

---
 HACKING.md   | 12 ++++++++++++
 README.md    | 11 +++++++----
 RELEASING.md |  9 ++++++---
 3 files changed, 25 insertions(+), 7 deletions(-)

diff --git a/HACKING.md b/HACKING.md
index 9702ab2..491bfb1 100644
--- a/HACKING.md
+++ b/HACKING.md
@@ -43,3 +43,15 @@ Kazu Yamamoto [explained it in his PR](https://github.com/yesodweb/wai/pull/752#
 1. Brittany
 2. mtl-style preferred
 3. no overly pointfree style
+
+## Code structure
+
+Main functionality is in `GHCup` module. Utility functions are
+organised tree-ish in `GHCup.Utils` and `GHCup.Utils.*`.
+
+Anything dealing with ghcup specific directories is in
+`GHCup.Utils.Dirs`.
+
+Download information on where to fetch bindists from is in
+`GHCup.Data.GHCupDownloads`.
+
diff --git a/README.md b/README.md
index bfa2250..88220bf 100644
--- a/README.md
+++ b/README.md
@@ -68,11 +68,14 @@ handles your haskell packages and can demand that [a specific version](https://c
 For man pages to work you need [man-db](http://man-db.nongnu.org/) as your `man` provider, then issue `man ghc`. Manpages only work for the currently set ghc.
 `MANPATH` may be required to be unset.
 
-### Bash-completion
+### Shell-completion
 
-Depending on your distro and setup, install `.bash-completion` from this repo
-as e.g. `/etc/bash_completion.d/ghcup` and make sure your bashrc sources the
-startup script (`/usr/share/bash-completion/bash_completion` on some distros).
+Shell completions are in `shell-completions`.
+
+For bash: install `shell-completions/bash`
+as e.g. `/etc/bash_completion.d/ghcup` (depending on distro)
+and make sure your bashrc sources the startup script
+(`/usr/share/bash-completion/bash_completion` on some distros).
 
 ## Design goals
 
diff --git a/RELEASING.md b/RELEASING.md
index 57cd277..f631c3f 100644
--- a/RELEASING.md
+++ b/RELEASING.md
@@ -4,8 +4,11 @@
 
 2. Add/fix downloads to `GHCupDownloads` module, then run `ghcup-gen gen` to generate the new json and validate it via `ghcup-gen check`.
 
-3. Commit and git push with tag. Wait for tests to succeed.
+3. Commit and git push with tag. Wait for tests to succeed and release artifacts to build.
 
-4. Upload the new `ghcup-<ver>.json` to `webhost.haskell.org/ghcup/data/`.
+4. Download release artifacts and upload them `downloads.haskell.org/ghcup`
+
+5. Add release artifacts to GHCupDownloads (see point 2.)
+
+6. Upload the final `ghcup-<ver>.json` to `webhost.haskell.org/ghcup/data/`.
 
-5. Build ghcup releases for Linux (fully static), mac (with `-fcurl`) and FreeBSD (with `-fcurl`). Upload to `webhost.haskell.org/ghcup/bin/` and update symlinks.