diff --git a/README.md b/README.md index d4dc7f2..b682a10 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,71 @@ -# Quack Mouse Converter -The Quack Mouse project is a Bluetooth & ADB Mouse "Dongle" for the Macintosh 128/512/Plus and the Apple Lisa. It allow you to use most ADB and BT2+ mouses with a Macintosh 128/512/Plus and Apple Lisa through the quadrature mouse port. +# Quack Mouse Converter   [![Badge License]][License] -It include a custom PCB (EDA subfolder) with the accompanying firmware (code in main subfolder) -![Board](https://raw.githubusercontent.com/demik/quack/master/Images/board.png) +A dongle that allows various retro systems to use the `Apple Desktop Bus`
+as well as `Bluetooth 2+` mice through their `quadrature` mouse ports. -### Supported mouse conversions: +
+
+
-Quack support the following conversions: -- ADB mouse to Macintosh 128/512/Plus or Apple Lisa -- Bluetooth mouse to Macintosh 128/512/Plus or Apple Lisa +
-### Unsupported mouse conversions: +[![Button Documentation]][Documentation]    +[![Button Firmware]][Firmware]    +[![Button PCB]][PCB]    +[![Button Changelog]][Changelog] -- ADB mouse to Bluetooth LE host -This is a work in progress for now, it doesn't work with all mainstream operating systems (Windows 10 works) +
+
-### Documentation + -More documentation is avaible on the Wiki. Please check it out: https://github.com/demik/quack/wiki +
+ +
+
+ +## Supported + +#### Systems + +  Macintosh 128 / 512 / Plus      Apple Lisa   + +#### Connection Types + +  Apple Desktop Bus      Bluetooth 2+   + +
+
+ +### Unsupported + +- `ADB`  ➞  `Bluetooth LE` for **Non-Windows 10** + +
+ + + + +[Documentation]: https://github.com/demik/quack/wiki + +[Changelog]: ChangeLog.md +[Firmware]: main/README.md +[License]: LICENSE +[PCB]: EDA/ChangeLog.md + + + + +[Badge License]: https://img.shields.io/badge/License-Apache_2.0-961b1f?style=for-the-badge&labelColor=D22128 + + + + +[Button Documentation]: https://img.shields.io/badge/Documentation-0099E5?style=for-the-badge&logoColor=white&logo=BookStack +[Button Changelog]: https://img.shields.io/badge/Changelog-21375A?style=for-the-badge&logoColor=white&logo=AzureArtifacts +[Button Firmware]: https://img.shields.io/badge/Firmware-E5426E?style=for-the-badge&logoColor=white&logo=ROS +[Button PCB]: https://img.shields.io/badge/PCB-007c40?style=for-the-badge&logoColor=white&logo=PowerApps diff --git a/Resources/Preview.png b/Resources/Preview.png new file mode 100644 index 0000000..aff883f Binary files /dev/null and b/Resources/Preview.png differ diff --git a/Images/board.png b/Resources/board.png similarity index 100% rename from Images/board.png rename to Resources/board.png