thiagohgl commited on
Commit
9b01b74
1 Parent(s): 54ec0b9

Added ffmpeg requirement

Browse files
Files changed (1) hide show
  1. README.md +9 -7
README.md CHANGED
@@ -1,19 +1,21 @@
1
 
2
  # Ai Pronunciation Trainer
3
- This tool uses AI to evaluate your pronunciation so you can improve it and be understood more clearly. To directly test the tool, go to https://aipronunciationtr.com (please use the chrome browser for desktop).
4
 
5
  ## Installation
6
- To run the program locally, all you need to do is to install the requirements and run the main python file:
7
  ```
8
  pip install -r requirements.txt
9
  python webApp.py
10
  ```
11
- The code is pure python; thus, you should be able to run it without any major issue as long as you’re using a recent python 3.X version.
 
 
12
 
13
  ## Online version
14
- For the people who don’t feel comfortable running code or just want to have a quick way to use the tool, I hosted an online version of it at https://aipronunciationtr.com. It should work without any major issues in desktop-chrome, any other browser is not officially supported, although most of the functionality should work fine.
15
 
16
- Please be aware that the usage is limited by day (I’m still not rich ;)). If, for some reason, you would like to skip the daily usage limit, just enter in contact and we can negotiate an additional API key only for you.
17
 
18
  ## Motivation
19
 
@@ -21,7 +23,7 @@ Often, when we want to improve our pronunciation, it is very difficult to self-a
21
 
22
  The AI pronunciation trainer is a way to provide objective feedback on how well your pronunciation is in an automatic and scalable fashion, so the only limit to your improvement is your own dedication.
23
 
24
- This project originated from a small program that I did to improve my own pronunciation. When I finished it, I believed it could be a useful tool also to other people trying to be better understood, so I decided to make a simple, more user-friendly version of it.
25
 
26
  ## Disclaimer
27
- This is a simple tool that I made in my free time with the goal to be useful to some people. It is not perfect, thus be aware that some small bugs may be present. In case you find something is not working, all feedback is welcome, and issues may be addressed depending on their severity.
 
1
 
2
  # Ai Pronunciation Trainer
3
+ This tool uses AI to evaluate your pronunciation so you can improve it and be understood more clearly. You can go straight test the tool at https://aipronunciationtr.com (please use the chrome browser for desktop and have some patience for it to "warm-up" :) ).
4
 
5
  ## Installation
6
+ To run the program locally, you need to install the requirements and run the main python file:
7
  ```
8
  pip install -r requirements.txt
9
  python webApp.py
10
  ```
11
+ You'all also need ffmpeg, which you can download from here https://ffmpeg.org/download.html. On Windows, it may be needed to add the ffmpeg "bin" folder to your PATH environment variable. On Mac, you can also just run "brew install ffmpeg".
12
+
13
+ You should be able to run it locally without any major issues as long as you’re using a recent python 3.X version.
14
 
15
  ## Online version
16
+ For the people who don’t feel comfortable running code or just want to have a quick way to use the tool, I hosted an online version of it at https://aipronunciationtr.com. It should work well in desktop-chrome, any other browser is not officially supported, although most of the functionality should work fine.
17
 
18
+ Please be aware that the usage is limited by day (I’m still not rich ;)). If, for some reason, you would like to avoid the daily usage limit, just enter in contact and we see what we can do.
19
 
20
  ## Motivation
21
 
 
23
 
24
  The AI pronunciation trainer is a way to provide objective feedback on how well your pronunciation is in an automatic and scalable fashion, so the only limit to your improvement is your own dedication.
25
 
26
+ This project originated from a small program that I did to improve my own pronunciation. When I finished it, I believed it could be a useful tool also for other people trying to be better understood, so I decided to make a simple, more user-friendly version of it.
27
 
28
  ## Disclaimer
29
+ This is a simple project that I made in my free time with the goal to be useful to some people. It is not perfect, thus be aware that some small bugs may be present. In case you find something is not working, all feedback is welcome, and issues may be addressed depending on their severity.