Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
louangr committed Aug 19, 2023
1 parent 0285590 commit 72e05e4
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 2 deletions.
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,16 @@
# WIP: Translator
# Translator

Windows desktop app to translate in real-time from audio input and based on [Microsoft Azure Cognitives Services](https://azure.microsoft.com/fr-fr/products/cognitive-services/speech-services/)

## Not ready yet... but soon 😉
## First release is here 🎉

Download it in the [release](https://github.com/louangr/Translator/releases) section

## What does it look like?

<img src="./docs/images/homePage.png" />
<img src="./docs/images/translationPage.png" />

## How to install it?

Let's see the steps in this [doc](./docs/installation/README.md)
Binary file added docs/images/homePage.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/translationPage.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
19 changes: 19 additions & 0 deletions docs/installation/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
To install the package, you need to :

- in `Windows Settings` > `Privacy and Security` > `For developers`, enable `Developer Mode`

- open the `Package` folder, press `Shift` and right-click the `Install.ps1` file, then select `Copy as path`

- open `Windows Powershell` as Administrator

- run `Set-ExecutionPolicy Bypass`, validate by typing `Y` as Yes

- paste the path to `Install.ps1` file you copied, remove quotes and run it (eg: `C:\Path\To\Package\Install.ps1`)

- if necessary, validate installation of the certificate by typing `Y` as Yes on the next steps

- a confirmation message appears when the installation is complete.

- run `Set-ExecutionPolicy Restricted`, validate by typing `Y` as Yes

- in `Windows Settings` > `Privacy and Security` > `For developers`, disable `Developer Mode`

0 comments on commit 72e05e4

Please sign in to comment.