Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
george-norton committed Jun 5, 2023
1 parent 677b6e9 commit 8a5066c
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@ Ploopy Headphones Toolbox is an application for configuring the filtering applie

![Screenshot Ploopy Headphones Toolbox.](screenshot.png)

To use this tool you will need to be running a firmware image build from the [headphones-toolbox branch](https://github.com/george-norton/headphones/tree/headphones-toolbox), prebuild binaries are available [here]().
To use this tool you will need to be running a firmware image build from the [headphones-toolbox branch](https://github.com/george-norton/headphones/tree/headphones-toolbox), prebuild binaries are available [here](https://github.com/george-norton/headphones/releases/tag/headphones-toolbox-alpha-v1).

## Quickstart guide

Grab a firmware image from [here]() and flash it onto your DAC.
Grab a build of Ploopy Headphones Toolbox from [here]() and install it on your PC.
Grab a firmware image from [here](https://github.com/george-norton/headphones/releases/tag/headphones-toolbox-alpha-v1) and flash it onto your DAC.
Grab a build of Ploopy Headphones Toolbox from [here](https://github.com/george-norton/headphones-toolbox/releases/tag/headphones-toolbox-alpha-v1) and install it on your PC.
If you are a Linux user you will need to set a udev rule to allow users to access the USB device. As root, run:
```
echo 'SUBSYSTEM=="usb", ATTRS{idVendor}=="2e8a", ATTRS{idProduct}=="fedd", MODE="666"' > /etc/udev/rules.d/100-ploopy-headphones.rules`
Expand Down Expand Up @@ -37,6 +37,10 @@ Implemented functionality:
- Save the configuration to flash.
- Load configs from flash.

Known issues:
- There is a short audio dropout when writing a config to flash.
- If you create and delete configurations the application may stop syncing changes to the device until the application is restarted.

## Developer guide

The application is build using [Tauri](https://tauri.app/), [Quasar](https://quasar.dev/) and a little [Rust](https://www.rust-lang.org/). These were picked for consistency with QMK who are using the same combination for their upcoming xap client application. The user interface itself is build with standard web technologies (vue3, quasar, html. typescript).
Expand Down

0 comments on commit 8a5066c

Please sign in to comment.