Skip to content

Commit

Permalink
Update usage.md
Browse files Browse the repository at this point in the history
  • Loading branch information
arcb01 committed Jan 15, 2024
1 parent 0ef1649 commit 4d04fe3
Showing 1 changed file with 5 additions and 6 deletions.
11 changes: 5 additions & 6 deletions docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,6 @@
- **Suported languages**: English and Spaniash

- **Python version**: `3.9.12`

> [!NOTE]
> a

### Installation
```python
Expand All @@ -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:

Expand All @@ -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.
Expand All @@ -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
Expand Down

0 comments on commit 4d04fe3

Please sign in to comment.