Skip to content

Commit

Permalink
Make a readme, and a banner for it
Browse files Browse the repository at this point in the history
  • Loading branch information
AntoineJT committed Jun 17, 2020
1 parent f450bc8 commit 3ab1f48
Show file tree
Hide file tree
Showing 5 changed files with 33 additions and 0 deletions.
Binary file added .images/Banner.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .images/Screenshots/Window.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
31 changes: 31 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# QuietMic 🎙️

![Banner](.images/Banner.png)

QuietMic is an application allowing you to globally toggle the state of your microphone. \
I originally developed it in order to use keyboard shortcut to mute my microphone when someone makes noise when I'm in livestream. \
This is my first ever C# application, therefore my first WPF application too.

For now, this application works, but it is really basic. I plan to work on it more, but for now it is enough for my needs.

## Features

* Select one microphone in your microphone list
* Toggle the mute status of your selected microphone using Alt+PageUp
* Optional sound notifications (one for mute status, another for unmute status) when using keyboard shortcut
* By default, the microphone is reactivated when closing the application

## Work in progress

* I'm working on a tray menu: for now, only the icon is here
* Some other ideas I will implement one day

## Screenshots

![Window screenshot](.images/Screenshots/Window.png)

## Notes
### File formats

- PDN: [Paint.NET project file](https://www.getpaint.net/index.html)
- MMPZ: [LLMS project file](https://lmms.io/)
Binary file added Resources/Banner/Banner.pdn
Binary file not shown.
2 changes: 2 additions & 0 deletions Resources/Banner/CREDITS
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
See CREDITS file from Resources/Logo folder
The font used here is Budmo Jiggler from Typodermic Fonts: https://www.dafont.com/fr/budmo.font?l[]=10&l[]=1

0 comments on commit 3ab1f48

Please sign in to comment.