Skip to content

Commit

Permalink
Updated readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
sanraith committed Jul 17, 2020
1 parent 9ecab79 commit fdab703
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 6 deletions.
19 changes: 13 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,19 @@
Keeps a wireless headset awake by periodically playing sounds inaudible to the human ear.
I made this because my HyperX Cloud Flight headset automatically turns off after ~15 minutes of inactivity.

Requirements:
![keep-headset-awake in action](docs/screenshot.png)

- .NET Core 3.1 SDK

Usage:
## Usage

- Ensure that .NET Core 3.1 Runtime is installed.
- Download and unzip the binaries from [the latest release](https://github.com/sanraith/keep-headset-awake/releases/latest).
- Edit `appsettings.json` to customize the beep length, frequency and interval.
- Start with `dotnet run`
- Press CTRL+C to stop.
- Run `keep-headset-awake.exe`.
If you want to hide the a console, run `keep-headset-awake-NOCONSOLE.exe` instead.

## Build from source

- Ensure that .NET Core 3.1 SDK is installed.
- Clone the repo with `git clone https://github.com/sanraith/keep-headset-awake.git`
- Run `publish.bat` from the project directory.
The binaries are placed into `bin\keep-headset-awake\`
Binary file added docs/screenshot.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 fdab703

Please sign in to comment.