From 86f08d776bac260e1c7fd00f656e3a0f22d19cc9 Mon Sep 17 00:00:00 2001 From: ElectronicsArchiver <85485984+ElectronicsArchiver@users.noreply.github.com> Date: Tue, 5 Jul 2022 06:51:16 -0400 Subject: [PATCH] Formatted README --- README.md | 81 ++++++++++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 68 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index d4dc7f2..46f7cfd 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,76 @@ -# 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) +This dongle allows various retro systems to use `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: +--- -- 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) +[![Button Documentation]][Documentation]    +[![Button Firmware]][Firmware]    +[![Button PCB]][PCB]    +[![Button Changelog]][Changelog] -### Documentation +--- -More documentation is avaible on the Wiki. Please check it out: https://github.com/demik/quack/wiki +
+ +![Board] + +
+ +
+
+ +## Configurations + +
+ +### Supported + + + + + +
Systems
Macintosh128
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 +[Board]: Resources/Preview.png +[PCB]: EDA/Changelog.md + + + + +[Badge License]: https://img.shields.io/badge/License-Apache_2.0-D22128?style=for-the-badge + + + + +[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