From 4d04fe318abe1b692e0413c233dd3d90fc8a94a0 Mon Sep 17 00:00:00 2001 From: Arnau Castellano Date: Mon, 15 Jan 2024 19:15:20 +0100 Subject: [PATCH] Update usage.md --- docs/usage.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/docs/usage.md b/docs/usage.md index ec1e624..d07ac8c 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -6,9 +6,6 @@ - **Suported languages**: English and Spaniash - **Python version**: `3.9.12` - -> [!NOTE] -> a ### Installation ```python @@ -23,7 +20,7 @@ python setup.py install # Install GUI componentes (visit issue for more info) python -m pip install PyQt5 - +``` ## How to use? First and foremost, watch the demo video on the README to get an introduction on how the app works. Once watched you would've noticed that the app has 2 modes, regional and SnQ: @@ -33,7 +30,8 @@ First and foremost, watch the demo video on the README to get an introduction on Before running the application, set your prefered key bindings by editing `/config/keys.json/` file. > [!NOTE] -> Key binding names must be in the same language as your OS. +> 1. Key binding names must be in the same language as your OS. +> 2. GPU is not required but is recomended for reducing inference times. > [!IMPORTANT] > If you plan on using the narrator while playing videogames, make sure that the game is set to borderless window. @@ -45,7 +43,8 @@ gnarrator ## Known issues (Work in progress) > [!WARNING] -> App still in development, issues can ocurr frequently +> App still in development, issues can ocurr frequently +> Visit [issues](https://github.com/arcb01/g-narrator/issues) for more information **Bug list** - [ ] When using the app while gaming, it can ocurr that the language from the keybaord changes during execution and therefore keyboard input stops working