Skip to content

Commit

Permalink
Write better docs
Browse files Browse the repository at this point in the history
  • Loading branch information
richrace committed Sep 24, 2023
1 parent b9602de commit 392cfcc
Show file tree
Hide file tree
Showing 3 changed files with 41 additions and 3 deletions.
44 changes: 41 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@

This Electron application will create a Tray application to show the current battery level and some other information about the headset.

![Screen shot showing the app, with battery percentage, help and quit actions](docs/arctis-monitor.png)
![Screen shot showing the app, with battery percentage, help and quit actions on macOS](docs/arctis-monitor-mac.png)

![Screen shot showing the app, with battery percentage, help and quit actions on Windows](docs/arctis-monitor-windows.png)

## [See the Releases Page](https://github.com/richrace/arctis-monitor/releases)

Expand Down Expand Up @@ -31,9 +33,43 @@ Supported headsets are provided by [Arctis USB Finder](https://github.com/richra

If yours isn't on the list follow the instructions on the [Arctis USB Finder's Probe](https://github.com/richrace/arctis-usb-finder#probe)

## Debug

### Windows

To get the debug menu you have to press the <kbd>⇧ Shift</kbd> key at the same time you click, and then right click to
load the menu.

#### Install Location

File explorer: `%localappdata%\arctis-monitor` double click `arctis-monitor`.

#### Force

To force load a refresh of headphones press the <kbd>Alt</kbd> key at the same time you click, and then right click to
see any changes.

### macOS

To get the debug menu you have to press the <kbd>⌥ Option</kbd> key at the same time you click the menu.

#### Force

To force load a refresh of headphones press the <kbd>⇧ Shift</kbd> key.

## Development

Clone the repo
### Dependency

The logic to find the headphones is abstracted to this repo / npm package [arctis-usb-finder](https://github.com/richrace/arctis-usb-finder).

You can checkout that package if you want to edit it, and change the npm dependency to the directory you've cloned it
to e.g. `"arctis-usb-finder": "file:../arctis-usb-finder"`. If you make a change, as it's written in TypeScript you must
build it first and restart this application to refresh the code.

### This electron app

Clone this repo

Run
```
Expand All @@ -45,6 +81,8 @@ and then
npm start
```

## Credtis
As it's written in TypeScript you will need to kill and restart start after each change.

## Credits

* Icons made by [Freepik](https://www.flaticon.com/authors/freepik "Freepik") from [www.flaticon.com](https://www.flaticon.com/ "Flaticon")
File renamed without changes
Binary file added docs/arctis-monitor-windows.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 392cfcc

Please sign in to comment.