Compare commits

..

4 commits

Author SHA1 Message Date
G2
7630ca23a0
Update README.md 2024-06-19 10:36:45 -05:00
G2
ba625ad8be
Update README.md 2024-06-19 10:36:21 -05:00
G2
556f4331b7
Update README.md - Added badges 2024-06-19 10:05:45 -05:00
89691df5f1 Updated README.md 2024-06-19 09:44:36 -05:00

View file

@ -1,21 +1,31 @@
# Rust Minidisc
![Crates.io Version](https://img.shields.io/crates/v/minidisc?style=for-the-badge)
![docs.rs](https://img.shields.io/docsrs/minidisc?style=for-the-badge)
A library for controlling and interfacing with [MiniDisc](https://en.wikipedia.org/wiki/MiniDisc) devices from within Rust programs. Compatible with many cross platform targets (including Web Assembly!) by using [cross-usb](https://github.com/G2-Games/cross-usb).
The feature set is very similar to that of [netmd-js](https://github.com/cybercase/netmd-js) which this library is inspired by. For more information check out the absolutely awesome [Web Minidisc project](https://github.com/asivery/webminidisc), [NetMD-exploits](https://github.com/asivery/netmd-exploits), and the C based [Linux Minidisc project](https://github.com/linux-minidisc/linux-minidisc).
The feature set is very similar to that of [netmd-js](https://github.com/cybercase/netmd-js) which this library is inspired by. Devlopment of this project was made much easier by the absolutely awesome [Web Minidisc project](https://github.com/asivery/webminidisc), [NetMD-exploits](https://github.com/asivery/netmd-exploits), and the C based [Linux Minidisc project](https://github.com/linux-minidisc/linux-minidisc). Go check those projects out!
Documentation has not been finished and is a work in progress.
> [!IMPORTANT]
> Documentation has not been finished and is a work in progress. Any help with it would be appreciated!
## Current Features
### NetMD
- [x] Track upload
- [x] Track management
- [x] Playback control
- [ ] Group Management
- [x] Track download ([MZ-RH1](https://www.minidisc.wiki/equipment/sony/portable/mz-rh1) only)
- [x] Group Management
- [x] Track download ([MZ-RH1](https://www.minidisc.wiki/equipment/sony/portable/mz-rh1) only)
- [ ] Factory Mode
### Hi-MD
- [ ] Track upload
- [ ] Track management
- [ ] Playback control
- [ ] Group Management
- [ ] Track download
## Todo
- [ ] Exploits (from [NetMD-exploits](https://github.com/asivery/netmd-exploits))
- [ ] Hi-MD experimentation
- [ ] Documentation
- [ ] Better JS bindings