diff --git a/README.md b/README.md new file mode 100644 index 0000000..8e97a0f --- /dev/null +++ b/README.md @@ -0,0 +1,20 @@ +# rtTranslator + +Simple overlay for Windows, that listens for background sound and translates it to text thats displayed on the screen. + +![](images/screenshot.png) + +## Installation + +0. Set your loopback device as default device +1. Clone the repository +2. Change `config.py` to your liking +3. Install the requirements +4. Run `python -m app` + +For now it's only working on windows, but I'm planning to make it cross-platform. +> YOU NEED A LOOPBACK DEVICE FOR THIS, I RECOMMEND [VB-CABLE](https://vb-audio.com/Cable/) WITH [VOICEMEETER](https://vb-audio.com/Voicemeeter/index.htm). + +## Usage + +Just run app and it will start listening for sound and translating it to text. \ No newline at end of file diff --git a/images/screenshot.png b/images/screenshot.png new file mode 100644 index 0000000..8fddc52 Binary files /dev/null and b/images/screenshot.png differ