Skip to content

Commit

Permalink
new method
Browse files Browse the repository at this point in the history
  • Loading branch information
arcb01 committed Jan 15, 2024
1 parent 586bbdc commit 0ef1649
Show file tree
Hide file tree
Showing 6 changed files with 20 additions and 109 deletions.
5 changes: 1 addition & 4 deletions .github/workflows/code-eval.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,8 @@ jobs:
python-version: "3.10"
- name: Install application
run: |
python -m pip install --upgrade pip
python setup.py install
python -m pip uninstall PyQt5 -y
python -m pip uninstall PyQt5-Qt5 -y
python -m pip install PyQt5 --upgrade
python -m pip install PyQt5
shell: cmd
- name: Testing
run: |
Expand Down
39 changes: 0 additions & 39 deletions .github/workflows/python-app.yml

This file was deleted.

24 changes: 19 additions & 5 deletions docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,24 @@

- **Suported languages**: English and Spaniash

- **Python version**: 3.9+
- **Python version**: `3.9.12`

> [!IMPORTANT]
> GPU is recomended for faster inference times.
> [!NOTE]
> a
### Installation
Run the `installation.bat` and let the installation follow.
```python
# Create new environment
python -m venv .env

# Activate environment
.\.env\Scripts\Activate.ps1

# Install setup.py
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 @@ -27,7 +38,10 @@ Before running the application, set your prefered key bindings by editing `/conf
> [!IMPORTANT]
> If you plan on using the narrator while playing videogames, make sure that the game is set to borderless window.

Finally, start the app by running the `run.bat` file
Finally, start the app by running:
```python
gnarrator
```

## Known issues (Work in progress)
> [!WARNING]
Expand Down
43 changes: 0 additions & 43 deletions installation.bat

This file was deleted.

Binary file modified requirements.txt
Binary file not shown.
18 changes: 0 additions & 18 deletions run.bat

This file was deleted.

0 comments on commit 0ef1649

Please sign in to comment.