From 9a4d7f90b7b4a7861db0d6e1efc6db33ec6f1491 Mon Sep 17 00:00:00 2001
From: Giovanni La Mura <giovanni.lamura@inaf.it>
Date: Mon, 25 Sep 2023 14:51:07 +0200
Subject: [PATCH] Add markdown README instructions to build documents

---
 doc/src/README.md | 12 ++++++++++++
 1 file changed, 12 insertions(+)
 create mode 100644 doc/src/README.md

diff --git a/doc/src/README.md b/doc/src/README.md
new file mode 100644
index 00000000..877eb9dd
--- /dev/null
+++ b/doc/src/README.md
@@ -0,0 +1,12 @@
+# Folder instructions
+
+This directory contains the material to build the project documentation with `doxygen`.
+
+## Instructions
+
+The project documentation is managed by `doxygen`, a documentation generator that is able to extract documents directly from properly formatted comment sections of the source code. To build a local instance of project documents, make sure that you have `doxygen` installed, then `cd` into the document source folder (the folder containing the `conf.dox` file, specifically `np_tmcode/doc/src`) and then run:
+```
+doxygen conf.dox
+```
+
+`doxygen` will automatically build the HTML structure to cover all the documented source code and it will additionally provide the fundamental structure to prepare a LaTeX formatted version of the documents. These two outputs will be placed, respectively, under the folders `np_tmcode/doc/build/html` and `np_tmcode/doc/build/latex`.
\ No newline at end of file
-- 
GitLab