Added project settings documentation.

DegateCommunity · Jan 17, 2021 · 9c724a4 · 9c724a4
1 parent b78cf6a
commit 9c724a4
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 0 deletions.
diff --git a/pages/introduction.rst b/pages/introduction.rst
@@ -12,4 +12,5 @@ You will find below a list of topics that will present basic functionalities of
    introduction_dir/modules
    introduction_dir/rule_violations
    introduction_dir/shortcuts
+   introduction_dir/project_settings
    introduction_dir/window
diff --git a/pages/introduction_dir/images/project_settings.png b/pages/introduction_dir/images/project_settings.png
diff --git a/pages/introduction_dir/project_settings.rst b/pages/introduction_dir/project_settings.rst
@@ -0,0 +1,15 @@
+Project settings
+==================================
+
+You will find in the project settings dialog (available from the 'Project' submenu of the top bar) different settings for your project. From example, you will be able to change the project name, description, default colors, default diameters and much more.
+
+.. image:: images/project_settings.png
+  :alt: Degate project settings dialog
+
+You will find below a description of the less comprehensive options:
+
++-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
+| Option                      | Description                                                                                                                                      |
++=============================+==================================================================================================================================================+
+| Lambda (in pixel(s)):       | It indicates how many pixels two electrically conductive objects may be apart from each other so that they are still considered to be connected. | 
++-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+