Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Added rebuild notes and additional documentation, moved English description to the top

(Sorry, I don't know Catala so I can't translate my changes!)
  • Loading branch information
ewheelerinc authored Jan 19, 2022
1 parent b5d9ea9 commit 75637fe
Showing 1 changed file with 40 additions and 25 deletions.
65 changes: 40 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,6 @@
# LocalSTT

(Jump to [English](#English))

### [Català]

> **Nota: Aquesta aplicació de moment només és una prova de concepte**
LocalSTT és una aplicació per Android que proporciona reconeixement automàtic de la parla sense necessitat de conexió a internet ja que tot el processament és local al mòbil.

Això és possible gràcies a:
- un RecognitionService que utilitza la llibreria de Vosk
- un RecognitionService que utilitza la lliberia de Mozilla Deepspeech
- una Activity que gestiona intents RECOGNIZE_SPEECH entre altres

El codi és actualment una prova de concepte i es basa fortament en els següents projectes:
- [Kõnele](https://github.com/Kaljurand/K6nele)
- [Vosk Android Demo](https://github.com/alphacep/vosk-android-demo)

LocalSTT hauria de funcionar amb la majoria de teclats i aplicacions que implementen la funció de reconeixement de veu a través d'un intent RECOGNIZE_SPEECH o directament fent servir la classe SpeechRecognizer d'Android. Ha estat provada amb èxit fent servir les següent aplicacions en un terminal Android 9:
- [AnySoftKeyboard](https://github.com/AnySoftKeyboard/AnySoftKeyboard)
- [Kõnele](https://github.com/Kaljurand/K6nele)
- [SwiftKey](https://www.swiftkey.com)

Us podeu descarregar un APK que inclou models de Vosk i DeepSpeech pel català [aquí](https://github.com/ccoreilly/LocalSTT/releases/download/2020-12-03/localstt.apk).
(Jump to [Català](#Català))

### [English]

Expand All @@ -46,8 +24,45 @@ LocalSTT should work with all keyboards and applications implementing speech rec

You can download a pre-built binary with Vosk and DeepSpeech models for catalan [here](https://github.com/ccoreilly/LocalSTT/releases/download/2020-12-03/localstt.apk).

If you want to use the application with your language just replace the models in `app/src/main/assets/sync` and rebuild the application.
If you want to use the application with your language just replace the models in `app/src/main/assets/sync/vosk-model/` with a package from https://alphacephei.com/vosk/models and rebuild the application.

#### Build notes:
- git clone https://github.com/ewheelerinc/LocalSTT.git
- ./gradlew build
- ./repack-n-sign.sh ./app/build/outputs/apk/release/app-release-unsigned.apk
- You might need to update paths and keys in this script for your use.

#### BUGS:

- Does not work with Google's keyboard "GBoard".
- Not all record applications read the voice text properly, there must be another way---and if you know how, it is probably a trivial fix.

### Demo
#### Future Work

- Support query alphacephei.com and suppport selection+download of optional models. Then this apk can be packaged _without_ a language (much smaller!).

#### Demo

![LocalSTT in action](./demo.gif)

### [Català]

> **Nota: Aquesta aplicació de moment només és una prova de concepte**
LocalSTT és una aplicació per Android que proporciona reconeixement automàtic de la parla sense necessitat de conexió a internet ja que tot el processament és local al mòbil.

Això és possible gràcies a:
- un RecognitionService que utilitza la llibreria de Vosk
- un RecognitionService que utilitza la lliberia de Mozilla Deepspeech
- una Activity que gestiona intents RECOGNIZE_SPEECH entre altres

El codi és actualment una prova de concepte i es basa fortament en els següents projectes:
- [Kõnele](https://github.com/Kaljurand/K6nele)
- [Vosk Android Demo](https://github.com/alphacep/vosk-android-demo)

LocalSTT hauria de funcionar amb la majoria de teclats i aplicacions que implementen la funció de reconeixement de veu a través d'un intent RECOGNIZE_SPEECH o directament fent servir la classe SpeechRecognizer d'Android. Ha estat provada amb èxit fent servir les següent aplicacions en un terminal Android 9:
- [AnySoftKeyboard](https://github.com/AnySoftKeyboard/AnySoftKeyboard)
- [Kõnele](https://github.com/Kaljurand/K6nele)
- [SwiftKey](https://www.swiftkey.com)

Us podeu descarregar un APK que inclou models de Vosk i DeepSpeech pel català [aquí](https://github.com/ccoreilly/LocalSTT/releases/download/2020-12-03/localstt.apk).

0 comments on commit 75637fe

Please sign in to comment.