Added tutorial pages, fixed title.

source/conf.py

@@ -24,10 +24,25 @@ exclude_patterns = []
 
 html_theme = "pydata_sphinx_theme"
 html_static_path = ["_static"]
+html_title = "NQRduckumentation"
+html_context  = {"default_mode": "light"}
+
 html_theme_options = {
-    'navbar_title': 'NQRduckumentation',
+    "icon_links": [
+        {
+            # Label for this link
+            "name": "GitHub",
+            # URL where the link will redirect
+            "url": "https://github.com/nqrduck/",
+            # Icon class (if "type": "fontawesome"), or path to local image (if "type": "local")
+            "icon": "fa-brands fa-square-github",
+            # The type of image to be used (see below for details)
+            "type": "fontawesome",
+        }
+   ]
 }
 
+
 extensions = [
     "sphinx.ext.autodoc",
     "sphinx.ext.autosummary",

source/index.rst

@@ -4,9 +4,20 @@ Welcome to the NQRduckumentation!
 .. figure:: _static/Logo_full.png
     :alt: NQRduck logo
 
+This program is intended as an educational tool for magnetic resonance experiments (NMR, NQR, ...). Its focus lies on modular behaviour depending on what nqrduck modules are installed. 
+
+The core of the program is the nqrduck. It provides a central interface for communication between the different modules. The nqrduck core loads all the installed modules in your python environment.
+
+The focus for spectrometers currently lies on LimeSDR based spectrometers (LimeSDR USB, LimeSDR Mini 2.0).
+
+
+
+
+
 .. toctree::
    :maxdepth: 1
    :caption: Contents:
 
-   api_reference/index
    tutorials/index
+   api_reference/index
+   

source/tutorials/index.rst

@@ -1,2 +1,25 @@
-Tutorials
-==========
+NQRduck Tutorials 🦆
+====================
+
+
+Introduction
+------------
+
+This is a collection of different tutorials for the NQRduck program.
+
+- :doc:`0. NQRduck Setup <tutorial_0>` - This tutorial shows you how to setup the NQRduck program.
+
+- :doc:`1. NQRduck Simulator <tutorial_1>` - This tutorial shows you how to use the NQRduck Simulator.
+
+- :doc:`2. LimeNQR <tutorial_2>` - This tutorial shows you how to use the LimeNQR spectrometer with the NQRduck program.
+
+Tutorials in work
+-----------------
+
+- Automatic Tuning and Matching - This tutorial shows you how to use the Automatic Tuning and Matching module.
+
+- Broadband - This tutorial shows you how to use the Broadband module.
+
+- Developing a new module - This tutorial shows you how to develop a new module for the NQRduck program.
+
+- Signal Processing - This tutorial shows you how to perform signal processing with the NQRduck program.

source/tutorials/tutorial_0.rst

@@ -0,0 +1,43 @@
+0. NQRduck Setup Tutorial 🦆
+============================
+
+Introduction
+------------
+This Tutorial gives a short overview of how to setup the NQRduck program. The NQRduck program is a collection of different modules that can be installed separately. The core program is the main entry point and provides a user interface to access the different modules. 
+
+Requirements
+------------
+
+- Python 3.10+
+- pip
+- virtualenv
+- About 600MB of free storage space
+
+
+Steps (Linux)
+-------------
+1. Install the specified requirements.
+
+2. Create a virtual environment and activate it:
+
+.. code-block:: bash
+
+    python -m venv venv
+    . venv/bin/activate
+
+3. You can now install the NQRduck core program:
+
+.. code-block:: bash
+
+    pip install nqrduck
+
+
+4. Run the program with `nqrduck`. This should open up a window with the NQRduck program.
+
+5. The install wizard for different modules should open up. Install the `nqrduck-spectrometer`, `nqrduck-spectrometer-limenqr`, `nqrduck-pulseprogrammer` and `nqrduck-measurements` modules. You can also install other modules if you like.
+
+6. You can switch between different modules with the toolbar. The installed modules should be `Measurement` and `Spectrometer`. You can also check all available modules by opening `Help -> About Modules`.
+
+7. If you don't like how the program looks, you can change the appearance in `Settings -> Preferences`. Settings are saved and restored on the next start. Updating of the plot font size requires a restart of the program.
+
+8. Continue the tutorial with the NQRduck Simulator Tutorial.

source/tutorials/tutorial_1.rst

@@ -0,0 +1,2 @@
+1. NQRduck Simulator Tutorial 🦆
+================================

source/tutorials/tutorial_2.rst

@@ -0,0 +1,2 @@
+2. LimeNQR Tutorial 🦆
+======================