From 8f5bc35959c962566772a9a09a7fec84c074e705 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Romain=20Bron=C3=A8s?= <romain.brones@synchrotron-soleil.fr>
Date: Tue, 27 Feb 2024 17:05:35 +0100
Subject: [PATCH] chore(doc): Add module doc

---
 FofbTool/__init__.py | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/FofbTool/__init__.py b/FofbTool/__init__.py
index d3c8880..27ab57e 100644
--- a/FofbTool/__init__.py
+++ b/FofbTool/__init__.py
@@ -1 +1,17 @@
+"""
+FofbTool is a module to operate and configure the Fast Orbit Feedback (FOFB) platform at SOLEIL.
+
+This package is cut in several modules:
+    * FofbTool.Utils
+        Contains usefull functions, or first level function that make use of the core functions.
+
+    * FofbTool.Operation
+        Contains core functions to make actions on the (FOFB) platform.
+
+    * FofbTool.Configuration
+        Contains core functions to apply configurations on the FOFB platform
+
+For basic usage, see doc of FofbTool.Utils
+
+"""
 __version__ = "2.2"
-- 
GitLab