From 83962db2b128b8fd1b2a6804afc117686786f631 Mon Sep 17 00:00:00 2001
From: kpetersn <kmpeters@anl.gov>
Date: Thu, 2 Mar 2023 16:02:20 +0000
Subject: [PATCH] Added FAQ section. Clarified that APS computers should run
 RHEL.

---
 README.md | 28 ++++++++++++++++++++++++++--
 1 file changed, 26 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index e5af42d..20cecbb 100644
--- a/README.md
+++ b/README.md
@@ -4,8 +4,8 @@ This repo contains instructions for Session 2 of the Practical Beamline Controls
 
 ## Assumptions
 
-* The instructions assume the user is logged into an APS-maintained Linux computer.
-* The APS-maintained linux computer has access to /APSshare
+* The instructions assume the user is logged into an APS-maintained Red Hat Enterprise Linux (RHEL) computer.
+* The APS-maintained Red Hat Enterprise Linux (RHEL) computer has access to /APSshare
 
 ## Outline
 
@@ -29,3 +29,27 @@ $ ./quickstart.sh
 ```
 
 Then copy and paste the output from the script into the terminal and proceed to the "Deploy a new IOC" section.
+
+## FAQ
+
+#### Why isn't mkioc used to create the training IOC?
+
+mkioc renames files and directories (references to xxx are replaced with the desired IOC name).  This makes it impossible to have a **solution** branch in the git repo that works for everyone.
+
+#### How does the training IOC differ from one created with mkioc?
+
+There will be **fewer build errors** when building an IOC created by mkioc.
+
+The training IOC required some [customization to allow the IOC's prefix to be overridden](https://git.aps.anl.gov/practical_beamline_controls_training/session_2/xxx/-/commit/65cbe6b5f1e99442606ea7cb2efa5f2a602b9caa):
+
+* **st.cmd.Linux** sources **override.iocsh**, which overrides the default IOC prefix, `xxx:`, without requiring **settings.iocsh** to be edited.
+* the caQtDM (and MEDM) start scripts open **my-xxx.ui** (and **my-xxx.adl**) instead of **xxx.ui** (and **xxx.adl**)
+* A **newPrefix.sh** script was added to simplify the creation of **override.iocsh**, **my-xxx.ui** and **my-xxx.adl**
+
+#### Should I deploy beamline IOCs based on the traiing IOC?
+
+No.  Just use **mkioc**.
+
+#### Can I complete this exercise on a computer other than an APS-maintained RHEL computer?
+
+No.
-- 
GitLab