Merge pull request BeardOverflow#177 from mutchiko/main

Small improvments for README and list of supported devices

.github/ISSUE_TEMPLATE/support_request.yml

@@ -1,17 +1,16 @@
 name: New firmware request
-description: Request a new EC configuration to be added
+description: Request to add support for a new device (new EC configuration)
 labels: ["New firmware"]
 
 body:
   - type: markdown
     attributes:
       value: >
-        Please, get the latest version of the driver from github,
-        build it and load it in the debug mode, then fill out the fields below.
-
-        To build the driver from source, run `make`
-
-        To load the driver in the debug mode, run `sudo make load-debug`
+        Before you open a new issue, please check the [supported devices list](https://github.com/BeardOverflow/msi-ec/blob/main/docs/supported_devices.md),
+        If it's not there, you should follow the guide mentioned on the main page,
+        and then make a list of the addresses for features and their values to submit it here.
+        
+        It's also possible to skip the issue and make a pull request directly.
 
   - type: input
     id: model
@@ -25,15 +24,15 @@ body:
     id: ec-firmware
     attributes:
       label: EC firmware version
-      description: cat /sys/devices/platform/msi-ec/debug/fw_version
+      description: Get your current EC firmware version from the msi app on windows or the info page in the bios
     validations:
       required: false
 
   - type: textarea
-    id: ec-dump
+    id: feature-list
     attributes:
-      label: EC memory dump
-      description: cat /sys/devices/platform/msi-ec/debug/ec_dump
+      label: List of addresses and their values
+      description: Make a list of address = value for each possible feature, you can submit an incomplete list and continue later
       render: text
     validations:
       required: false

README.md

@@ -4,7 +4,11 @@
 
 This driver might not work on other laptops produced by MSI. Use it at your own risk, we are not responsible for any damage suffered.
 
-Also, and until future enhancements, no DMI data is used to identify your laptop model. In the meantime, check the msi-ec.c file before using.
+Also, and until future enhancements, no DMI data is used to identify your laptop model. In the meantime, check the list of supported devices and the msi-ec.c file before using.
+
+The driver has no effect on ACPI, so if you have any ACPI errors, the driver can't fix them; consider extracting the ACPI tables and/or following the [Arch wiki](https://wiki.archlinux.org/title/DSDT)
+
+You might want to use a graphical interface instead of executing commands to use the driver: [MControlCenter](https://github.com/dmitry-s93/MControlCenter). 
 
 
 ## Supported devices
@@ -15,8 +19,8 @@ Can't find your device in the list? Check the contribution guides and open a new
 
 ## Contribute
 Eager to support the project? Your help is always welcome to keep the project alive and going!
-- Read how to add support for your device and get the necessary information on Windows and Linux in [this guide](docs/device_support_guide.md)
-- Check out the relevant [wiki article](https://github.com/BeardOverflow/msi-ec/wiki/Contributing).
+- Read how to add support for your device and get the necessary information on Windows and Linux in [this guide](docs/device_support_guide.md).
+- Get solutions for common MSI laptop problems (ACPI errors, slow charger detection,...) and submit fixes if you have any in this [discussion](https://github.com/BeardOverflow/msi-ec/discussions/130#).
 - If you want to go deeper: [read into this discussion regarding EC firmware naming patterns](https://github.com/BeardOverflow/msi-ec/discussions/98).
 
 

docs/supported_devices.md

@@ -5,6 +5,11 @@
 - ⭕ - partially supported (has problems)
 - ❓ - supported by hardware but not the driver (yet?)
 
+# Instructions
+
+- Save some time and use the search functionality in your browser: ```ctrl+f``` and then type the model (example: ```Katana GF66 11UC```)
+- If you can't find your device on this list, follow [this guide](https://github.com/BeardOverflow/msi-ec/blob/main/docs/device_support_guide.md) to add support to your device and open a new issue 
+
 | Model                           | EC version | Issues & PRs                                                                                                                                                                                                                                                                                                                                 | ID |                      Functions                      |
 |---------------------------------|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | Alpha 15 B5EE / B5EEK           | 158LEMS1   | Issues:<br>- [#16](https://github.com/BeardOverflow/msi-ec/issues/16)<br> PRs:<br>- [#22](https://github.com/BeardOverflow/msi-ec/pull/22)                                                                                                                                                                                                   | 5  | ✔️ Battery thresholds <br> ✔️ Webcam toggle <br> ✔️ Webcam block <br> ✔️ Fn <-> Win <br> ✔️ Cooler boost <br> ✔️ Shift mode <br> ✔️ Fan mode <br> ✔️ Mic mute LED <br> ✔️ Sound mute LED <br> ❌ Keyboard backlight intensity                                        |