bdring · breiler · Dec 19, 2024
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1 @@
+/.idea/
diff --git a/README.md b/README.md
@@ -9,3 +9,49 @@ The official files are files that are typically used for firmware testing. They
 ## Contributed
 
 These are files contributed by users. They are grouped by the target controller. They are not maintained or tested by the FluidNC dev team. Feel free to add your own.
+
+## Guidelines for contributing
+
+These config files will be used in the **FluidNC Web Installer** as configuration templates. 
+By following these guidelines will make it easier for the user to select the correct configuration for their board and machine setup.
+
+### Folder structure
+
+The folder name will be used as a controller board name. Underlines `_` will be replaced with spaces and sub folders will be concatenated. Try to avoid any configuration specific details in the name.
+
+```
+contributed/
+    4x_2209
+    6_Pack/
+    6_Pack_External/
+    Jackpot_CNC_Controller/
+        LowRider_CNC_XYYZ/
+        MPCNC_XXYYZ/
+    pen_2209/
+        V2/
+        v2p1/
+```
+
+This will be read into the **FluidNC Web Installer** and will be displayed like this:
+
+![FluidNC Web Installer - Board selection](doc/images/board-selection.png)
+
+### Files structure
+Files that ends with `.yaml` will be selectable as configuration template. Try to come up with a name that indicates what is included in the config. It may for instance include if it is using a stepstick stepper driver and how many axes are configured.
+
+You can also place image files `logo.svg` or `logo.png` and `board.png` in the directory which will further help the user to select the correct board.
+
+### Configuration file
+Try to add a user friendly description to the yaml-configuration file. The `name` and `meta` fields will be displayed in the installer:
+
+```
+board: 6 Pack
+name: 6 Pack External XXYYZ Relay
+meta: |-
+  Configured with XYZ-axes. 
+  The X- and Y-axes are ganged. 
+  The spindle is configured with at relay on GPIO.25
+```
+
+![FluidNC Web Installer - Board create config](doc/images/board-create-config.png)
+
diff --git a/contributed/4x_2209/board.png b/contributed/4x_2209/board.png
diff --git a/contributed/4x_2209/logo.svg b/contributed/4x_2209/logo.svg
diff --git a/contributed/6_Pack/board.png b/contributed/6_Pack/board.png
diff --git a/contributed/6_Pack/logo.svg b/contributed/6_Pack/logo.svg
diff --git a/contributed/6_Pack_External/board.png b/contributed/6_Pack_External/board.png
diff --git a/contributed/6_Pack_External/logo.svg b/contributed/6_Pack_External/logo.svg
diff --git a/contributed/6x_CNC_Controller/board.png b/contributed/6x_CNC_Controller/board.png
diff --git a/contributed/6x_CNC_Controller/logo.svg b/contributed/6x_CNC_Controller/logo.svg
diff --git a/contributed/FYSETC_E4/board.png b/contributed/FYSETC_E4/board.png
diff --git a/contributed/FYSETC_E4/logo.png b/contributed/FYSETC_E4/logo.png
diff --git a/contributed/Jackpot_CNC_Controller/LowRider_CNC_XYYZZ/board.png b/contributed/Jackpot_CNC_Controller/LowRider_CNC_XYYZZ/board.png
diff --git a/contributed/Jackpot_CNC_Controller/LowRider_CNC_XYYZZ/logo.png b/contributed/Jackpot_CNC_Controller/LowRider_CNC_XYYZZ/logo.png
diff --git a/contributed/Jackpot_CNC_Controller/MPCNC_XXYYZ/board.png b/contributed/Jackpot_CNC_Controller/MPCNC_XXYYZ/board.png
diff --git a/contributed/Jackpot_CNC_Controller/MPCNC_XXYYZ/logo.png b/contributed/Jackpot_CNC_Controller/MPCNC_XXYYZ/logo.png
diff --git a/doc/images/board-create-config.png b/doc/images/board-create-config.png
diff --git a/doc/images/board-selection.png b/doc/images/board-selection.png