From aa2df8faa552fa2ccca9ca109cc64da02e9b8ddb Mon Sep 17 00:00:00 2001
From: TomLaclavere <129369785+TomLaclavere@users.noreply.github.com>
Date: Wed, 11 Sep 2024 09:32:07 +0200
Subject: [PATCH] Create README.md

---
 README.md | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..299da19
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@
+# Description
+
+Repository to perform End-to-end simulations of data acquisition and sky reconstruction with the QUBIC instrument. The reconstruction can be based on two different methods : the Frequency Map-Making (link arXiv) & the Component Map-Making (lien arXiv).
+
+The code documentation can be find following : https://mathias77515.github.io/Pipeline/docs/html/index.html
+
+# src
+
+src repository contains all the codes to perform the simulations and a large part of the analysis of the reconstructed sky maps : compute power spectra & fit cosmological/astrophysical parameters.
+
+# docs
+
+docs repository contains the files to build the API documentation. 
+
+## Documentation tutorial
+
+The API documentation is build using Sphinx (https://www.sphinx-doc.org/en/master/index.html). A general way to build it :
+
+```
+sphinx-apidoc -Mfeo docs/ path_to_package
+sphinx-build docs/ docs/html
+```
+
+The first line is used to build .rst files by reading the code in the package given by path_to_package (for example : src/CMM). These files are stored in docs but are not save on Github for simplicity.
+The second line is used to read the .rst files and to convert them in .html files, which we use to generate the API documentation.
+After a modification, if you want to visualise the documentation before commited it, you can use Firefox (or any other application) following :
+
+```
+firefox docs/html/index.html
+```