From 3a54095dadfc0be9dc496d794560918c6cf42bad Mon Sep 17 00:00:00 2001
From: Matteo Concas <mconcas@cern.ch>
Date: Wed, 7 Oct 2020 10:06:28 +0000
Subject: [PATCH] Add READMEs for Upgrade section

---
 Detectors/Upgrades/IT3/README.md         | 17 +++++++++++++++++
 Detectors/Upgrades/PostLS4/IT4/README.md | 17 +++++++++++++++++
 Detectors/Upgrades/README.md             | 19 +++++++++++++++++++
 3 files changed, 53 insertions(+)
 create mode 100644 Detectors/Upgrades/IT3/README.md
 create mode 100644 Detectors/Upgrades/PostLS4/IT4/README.md
 create mode 100644 Detectors/Upgrades/README.md

diff --git a/Detectors/Upgrades/IT3/README.md b/Detectors/Upgrades/IT3/README.md
new file mode 100644
index 0000000000000..3d57a976c41fa
--- /dev/null
+++ b/Detectors/Upgrades/IT3/README.md
@@ -0,0 +1,17 @@
+# IT3
+Upgraded version of the ITS that includes upgraded truly-cylindrical inner barrel.
+
+# Run the full simulation
+Provided O2 has been compiled with upgrades enabled, it is possible to simulate ITS 3 geometry within the `o2-sim` executable.
+
+## Simulation
+IT3 module is enabled via the `-m IT3` parameter.
+In case of `PIPE` to be enabled, the size of the beam pipe is automatically scaled to what is foreseen for the upgrades.
+
+Typical command to generate MC data:
+```bash
+o2-sim -m PIPE IT3 [...]
+```
+
+## Reconstruction
+Currently, the reconstruction is driven the `macro/run_trac_alice3.C`, which takes as input the hits generated by simulation. Hits can be smeared upon request (see `kUseSmearing`).
\ No newline at end of file
diff --git a/Detectors/Upgrades/PostLS4/IT4/README.md b/Detectors/Upgrades/PostLS4/IT4/README.md
new file mode 100644
index 0000000000000..672f26326d8e1
--- /dev/null
+++ b/Detectors/Upgrades/PostLS4/IT4/README.md
@@ -0,0 +1,17 @@
+# IT4
+At the moment the IT4 name is a placeholder for barrel detector.
+
+# Run the full simulation
+Provided O2 has been compiled with upgrades enabled, it is possible to simulate IT4 geometry within the `o2-sim` executable.
+
+## Simulation
+IT4 module is enabled via the `-m IT4` parameter.
+In case of `PIPE` to be enabled, the size of the beam pipe is automatically scaled to what is foreseen for the upgrades.
+
+Typical command to generate MC data:
+```bash
+o2-sim -m PIPE IT4 [...]
+```
+
+## Reconstruction
+Currently, the reconstruction is driven the `macro/run_trac_alice3.C`, which takes as input the hits generated by simulation. Hits can be smeared upon request (see `kUseSmearing`).
\ No newline at end of file
diff --git a/Detectors/Upgrades/README.md b/Detectors/Upgrades/README.md
new file mode 100644
index 0000000000000..c71db05187e1e
--- /dev/null
+++ b/Detectors/Upgrades/README.md
@@ -0,0 +1,19 @@
+<!-- doxy
+\page refDetectorsITSMFT ITSMFT
+/doxy -->
+
+# Upgrades
+This is a top page for detectors not included in Run 3 layout.
+
+# Installation
+
+To enable the compilation of this section it is required to prepend the `ENABLE_UPGRADES=ON` to the installation command, for instance:
+
+```bash
+ENABLE_UPGRADES=ON aliBuild build O2 --defaults o2
+```
+
+<!-- doxy
+* \subpage refIT3
+* \subpage refPostLS4
+/doxy -->
\ No newline at end of file