mirror of https://github.com/demik/quack.git
Formatted README
This commit is contained in:
parent
0ca38e2f0a
commit
86f08d776b
81
README.md
81
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)
|
This dongle allows various retro systems to use `Apple Desktop Bus` as <br>
|
||||||
![Board](https://raw.githubusercontent.com/demik/quack/master/Images/board.png)
|
well as `Bluetooth 2+` mice through their `quadrature` mouse ports.
|
||||||
|
|
||||||
### Supported mouse conversions:
|
<br>
|
||||||
|
|
||||||
Quack support the following conversions:
|
<div align = center>
|
||||||
- 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
|
[![Button Documentation]][Documentation]
|
||||||
This is a work in progress for now, it doesn't work with all mainstream operating systems (Windows 10 works)
|
[![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
|
<br>
|
||||||
|
|
||||||
|
![Board]
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<br>
|
||||||
|
<br>
|
||||||
|
|
||||||
|
## Configurations
|
||||||
|
|
||||||
|
<br>
|
||||||
|
|
||||||
|
### Supported
|
||||||
|
|
||||||
|
<table>
|
||||||
|
<tr><th colspan = 2 align = center>Systems</th></tr>
|
||||||
|
<tr><td><code>Macintosh</code><td align = center><code>128</code><br><code>512</code><br><code>Plus</code></td></tr>
|
||||||
|
<tr><td colspan = 2 align = center ><code>Apple Lisa</code></td></tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
| Connection Types
|
||||||
|
|:-----------------:
|
||||||
|
| `Apple Desktop Bus`
|
||||||
|
| `Bluetooth 2+`
|
||||||
|
|
||||||
|
<br>
|
||||||
|
|
||||||
|
## Unsupported
|
||||||
|
|
||||||
|
- `ADB` ➞ `Bluetooth LE` for **Non-Windows 10**
|
||||||
|
|
||||||
|
<br>
|
||||||
|
|
||||||
|
|
||||||
|
<!----------------------------------------------------------------------------->
|
||||||
|
|
||||||
|
[Documentation]: https://github.com/demik/quack/wiki
|
||||||
|
|
||||||
|
[Changelog]: Changelog.md
|
||||||
|
[Firmware]: main/README.md
|
||||||
|
[License]: LICENSE
|
||||||
|
[Board]: Resources/Preview.png
|
||||||
|
[PCB]: EDA/Changelog.md
|
||||||
|
|
||||||
|
|
||||||
|
<!-------------------------------[ Badges ]----------------------------------->
|
||||||
|
|
||||||
|
[Badge License]: https://img.shields.io/badge/License-Apache_2.0-D22128?style=for-the-badge
|
||||||
|
|
||||||
|
|
||||||
|
<!-------------------------------[ Buttons ]----------------------------------->
|
||||||
|
|
||||||
|
[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
|
||||||
|
|
Loading…
Reference in New Issue