Merge pull request #4 from netnef/patch-1

Patch 1
netnef · Dec 23, 2023 · 6d1eff6 · 6d1eff6
2 parents 9f24060 + 554f89e
commit 6d1eff6
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 8 deletions.
diff --git a/docs/contribute.md b/docs/contribute.md
@@ -5,6 +5,7 @@ The T2 project itself currently does not accept financial donations. However, so
 The best way of donation which we believe is in the form of skill. If you think you have the potential to help us in pushing the project further like fixing bugs, adding new features etc., you are free to do so. For this, you may contact our discord server, where other members of this organization are present.
 
 ## Contribute to the code
+
 See "partially working" features at [State](https://wiki.t2linux.org/state/) to get an idea of what's being worked on, and what should be worked on.
 
 ## Support our maintainers
@@ -16,5 +17,5 @@ Here is the list and links to donate some of our maintainers.
 - [marcosfad](https://github.com/marcosfad) - Played major role in getting Ubuntu working on T2 Macs. Donate via [Paypal](https://paypal.me/marcosfad) or [GitHub Sponsors](https://github.com/sponsors/marcosfad).
 - [NoaHimesaka1873](https://github.com/NoaHimesaka1873) - Currently maintains boot images for Arch, EndeavourOS, and Manjaro. Also maintains kernel for Manjaro too. Donate via [GitHub Sponsors](https://github.com/sponsors/NoaHimesaka1873) or [Toss (South Korea residents only)](https://toss.me/yuifmirror).
 - [Redecorating](https://github.com/Redecorating) - Currently maintains Arch kernel package, has written T2 related kernel patches and worked on T2 related kernel regressions. Donate via [PayPal](https://paypal.me/redecorating).
-- [AdityaGarg8](https://github.com/AdityaGarg8) - Current maintainer of Ubuntu. Has also helped in writing T2 kernel patches and upstreaming various patches. Donate via **Amazon Gift Cards India** ([Link for Indians](https://www.amazon.in/s?k=amazon+e-gift+voucher&adgrpid=60620499282&ext_vrnc=hi&gclid=Cj0KCQjw8O-VBhCpARIsACMvVLMW9KEhsWO9xHEvOh7VLo3lCimvvJJqaKdqwj-OlN_ZAMp3ZIztQ0AaAtGAEALw_wcB&hvadid=294106443315&hvdev=m&hvlocphy=9075215&hvnetw=g&hvqmt=b&hvrand=11733182626932158840&hvtargid=kwd-314681002020&hydadcr=15237_1791630&tag=googinhydrmob-21&ref=pd_sl_3qs6ai50tg_b), [Link for other countries](https://www.g2a.com/search?query=Amazon%20India)) or **GitHub sponsors** ([Link](https://github.com/sponsors/AdityaGarg8)). The cards can be emailed to **[email protected]** or via the discord.
+- [AdityaGarg8](https://github.com/AdityaGarg8) - Current maintainer of Ubuntu. Has also helped in writing T2 kernel patches and upstreaming various patches. Donate via **Amazon Gift Cards India** ([Link for Indians](https://www.amazon.in/s?k=amazon+e-gift+voucher&adgrpid=60620499282&ext_vrnc=hi&gclid=Cj0KCQjw8O-VBhCpARIsACMvVLMW9KEhsWO9xHEvOh7VLo3lCimvvJJqaKdqwj-OlN_ZAMp3ZIztQ0AaAtGAEALw_wcB&hvadid=294106443315&hvdev=m&hvlocphy=9075215&hvnetw=g&hvqmt=b&hvrand=11733182626932158840&hvtargid=kwd-314681002020&hydadcr=15237_1791630&tag=googinhydrmob-21&ref=pd_sl_3qs6ai50tg_b), [Link for other countries](https://www.g2a.com/search?query=Amazon%20India)), **GitHub sponsors** ([Link](https://github.com/sponsors/AdityaGarg8)) or **PayPal** ([Link](https://www.paypal.com/paypalme/AdityaGarg8)). The cards can be emailed to **[email protected]** or via the discord.
 - [networkException](https://github.com/networkException) - Wiki creator and maintainer. Donate via [GitHub Sponsors](https://github.com/sponsors/networkException).
diff --git a/docs/index.md b/docs/index.md
@@ -43,7 +43,8 @@ The following repos contain kernel modules for said support:
 
 ## Guides and similar
 
-Note that, if you are using one of the distributions listed above, you should follow their install guides rather than the ones listed under this section. However, they might still be important to gain a better general picture or to help with specific issues.
+!!! Warning "The following guides are third party"
+    These guides/configurations aren't supported by t2linux maintainers. Use at your own risk. If you are using one of the distributions listed above, you should follow their install guides rather than the ones listed under this section. However, they might still be important to gain a better general picture or to help with specific issues.
 
 - List of Mac Model Identifiers on [everymac.com](https://everymac.com/systems/by_capability/mac-specs-by-machine-model-machine-id.html)
 - Using Luks with the integrated keyboard [https://github.com/DimitriDokuchaev/GrubLuksUnlock](https://github.com/DimitriDokuchaev/GrubLuksUnlock)
@@ -53,11 +54,17 @@ Note that, if you are using one of the distributions listed above, you should fo
 - Get SMART information of your Apple Internal SSD using Linux [https://gist.github.com/AdityaGarg8/b03e57826213019fbffa747e1c724cac](https://gist.github.com/AdityaGarg8/b03e57826213019fbffa747e1c724cac)
 - Keyboard related issues [https://wiki.archlinux.org/title/Apple_Keyboard](https://wiki.archlinux.org/title/Apple_Keyboard)
 - Get silent boot experience similar to macOS and Windows on [Ubuntu](https://gist.github.com/AdityaGarg8/a39063f0d8c39572f03f55cbe02f9beb) and [Arch Linux](https://wiki.archlinux.org/title/silent_boot).
-- Implement macOS-like Keyboard and trackpad experience on **Gnome Xorg**. Read the top comments of each file in the links given below to understand requirements, additional tools and usage.
-    - [Synaptics Config](https://gist.github.com/smileBeda/f0452f0d7f1f6d8aa772603411f7876f) (for general trackpad behaviour using Synaptics)
-    - [Fusuma Config](https://gist.github.com/smileBeda/74a52fe7cb0901da9e67ae4e39966982) (for additional gestures commands using Fusuma)
 
-*Outdated*
+### Trackpad tuning
+
+- Wayland
+    - libinput tuning is typically applied by distribution maintainers rather than end users. You can test changes on your own, see [debugging touchpad pressure](https://wayland.freedesktop.org/libinput/doc/latest/touchpad-pressure-debugging.html) and [palm detection](https://wayland.freedesktop.org/libinput/doc/latest/palm-detection.html) guides. If you get a configuration that works well, please notify the t2linux maintainers.
+- Xorg **(deprecated, use Wayland instead if possible)**
+    - Implement macOS-like Keyboard and trackpad experience on Gnome Xorg. Read the top comments of each file in the links given below to understand requirements, additional tools and usage.
+        - [Synaptics Config](https://gist.github.com/smileBeda/f0452f0d7f1f6d8aa772603411f7876f) (for general trackpad behaviour using Synaptics)
+        - [Fusuma Config](https://gist.github.com/smileBeda/74a52fe7cb0901da9e67ae4e39966982) (for additional gestures commands using Fusuma)
+
+### Outdated
 
 - State of Linux on the MacBook Pro (technical documentation) [https://github.com/Dunedan/mbp-2016-linux](https://github.com/Dunedan/mbp-2016-linux)
 - Arch on 2018 MacBook Pro [https://gist.github.com/TRPB/437f663b545d23cc8a2073253c774be3](https://gist.github.com/TRPB/437f663b545d23cc8a2073253c774be3)

diff --git a/docs/state.md b/docs/state.md
@@ -8,12 +8,12 @@ While Linux is usable on all T2 models, some features are limited due to the lac
 |Screen, iGPU|🟢 Working|🟡 Partial|||
 |USB|🟢 Working|🟢 Yes|||
 |Keyboard|🟢 Working|🔴 No||[apple-bce](https://github.com/t2linux/apple-bce-drv)|
-|Trackpad|🟢 Working|🔴 No|Works, but isn't as great as on macOS (no force touch or palm rejection). Some models have deadzones on the edges of their trackpads where swipes along the trackpad that start in these deadzones will not be registered.|[apple-bce](https://github.com/t2linux/apple-bce-drv)|
+|Trackpad|🟢 Working|🔴 No|Works, but isn't as great as on macOS (no force touch or palm rejection). Some models have deadzones on the edges of their trackpads where swipes along the trackpad that start in these deadzones will not be registered.|[apple-bce](https://github.com/t2linux/apple-bce-drv), [Trackpad tuning](https://wiki.t2linux.org/#trackpad-tuning)|
 |Wi-Fi|🟢 Working|🟢 Yes|Requires macOS firmware|[Setup guide](https://wiki.t2linux.org/guides/wifi-bluetooth/)|
 |Bluetooth|🟡 Partially working|🟢 Yes|Requires macOS firmware only for devices with BCM4377 chip. Also, Bluetooth glitches on devices with BCM4377 Chip if connected to a 2.4 Ghz Wi-Fi connection. Thus, in order to use Bluetooth either turn off your Wi-Fi or use a 5Ghz Wi-Fi connection.|[Setup guide](https://wiki.t2linux.org/guides/wifi-bluetooth/)|
 |Camera|🟢 Working|🔴 No||[apple-bce](https://github.com/t2linux/apple-bce-drv)|
 |Thunderbolt|🟢 Working|🟢 Yes|If it doesn't work, try replacing `pcie_ports=compat` with `pcie_ports=native` in the kernel parameters via GRUB.||
-|Touch Bar|🟢 Working|🔴 No|"Touch Bar Keyboard" mode works OOTB, where only the Function Keys or the Media/Brightness Control Keys are shown. Support for custom graphics on the Touch Bar is being actively developed.|[tiny-dfr](https://github.com/kekrby/tiny-dfr)<br>[apple-ib](https://github.com/t2linux/apple-ib-drv)|
+|Touch Bar|🟢 Working|🔴 No|"Touch Bar Keyboard" mode works OOTB, where only the Function Keys or the Media/Brightness Control Keys are shown. Support for custom graphics on the Touch Bar is being actively developed.|[tiny-dfr](https://github.com/kekrby/tiny-dfr), [apple-ib](https://github.com/t2linux/apple-ib-drv)|
 |Suspend|🟡 Partially working|🟢 Yes|A firmware upgrade attached to macOS Sonoma broke suspend. Some users were having difficulty with it even before Sonoma. The issue has something to do with the apple-bce driver, because suspend works when it's disabled.|[#53](https://github.com/t2linux/T2-Ubuntu-Kernel/issues/53)|
 |Audio|🟡 Partially working|🔴 No|With proper configuration audio can work, however it is not stable in some older kernels and switching between speakers and when using the microphone. Microphone volume is low in some Macs.|[apple-bce](https://github.com/t2linux/apple-bce-drv)|
 |Hybrid Graphics|🟡 Partially working|🟡 Partial|Toggling dGPU power doesn't work.|[Hybrid Graphics](https://wiki.t2linux.org/guides/hybrid-graphics/)|
@@ -23,5 +23,7 @@ While Linux is usable on all T2 models, some features are limited due to the lac
 |T2 Audio Video Encoder|🔴 Not working||Used for Sidecar on macOS||
 
 ## Filesystem notes
+
 - Linux using APFS filesystems: Linux cannot read the internal SSD's macOS APFS parition's Data and System volume (for other APFS volumes, [linux-apfs-rw](https://github.com/linux-apfs/linux-apfs-rw) can be used for reading data, but attempting to write is risky).
+
 - macOS using Linux filesystems: There are FUSE implementations of some Linux Filesystems that can be used on macOS (but again, most only have experemental write support).