improve readme

README.md

@@ -4,26 +4,31 @@ A multilingual automatic speech recognition and video captioning tool using fast
 
 <video width="400" height="300" src="https://github.com/marquesafonso/multilang-asr-captioner/assets/79766107/fcff8ac1-cdfc-4400-821c-f797d84c2d8a"></video>
 
-## Docker
+## Requirements and Instalations
 
-1. clone the repo
-```{bash}
-git clone [email protected]:marquesafonso/multilang-asr-captioner.git
-```
-2. Build and run the container using docker-compose
+### Docker (preferred)
 
-```{bash}
-docker compose up
-```
-Then check the [landing page](http://127.0.0.1:8000). 
+You'll need to install [docker](https://www.docker.com/products/docker-desktop/).
 
-From there you will see the [submit_video endpoint](http://127.0.0.1:8000/submit_video/) and the [documentation](http://127.0.0.1:8000/docs/)
+Then, follow the steps below.
 
-Tip: on Linux or Mac localhost will resolve directly to 0.0.0.0 but on windows you will need to change it to 127.0.0.1
+    1. clone the repo
+    ```{bash}
+    git clone [email protected]:marquesafonso/multilang-asr-captioner.git
+    ```
+    2. Build and run the container using docker-compose
 
-## Local
+    ```{bash}
+    docker compose up
+    ```
 
-### Requirements and Instalations
+Check the [landing page](http://127.0.0.1:8000). 
+
+From there you will see the [submit_video endpoint](http://127.0.0.1:8000/submit_video/) and the [documentation](http://127.0.0.1:8000/docs/)
+
+**Tip**: on Linux or Mac localhost will resolve directly to 0.0.0.0 but on windows you will need to change it to 127.0.0.1
+
+### Local
 
 To run this tool locally on your computer you will need the following sofware installed:
 + [ImageMagick](https://imagemagick.org/script/download.php)
@@ -41,32 +46,34 @@ pipenv install
 
 Note that this assumes a proper Git installation and ssh key configuration. 
 
-### Quick start
+## Quick start (local)
+
+### API
 
-#### Command Line Interface
+A FastAPI API is available. This is the easiest way to use the program locally, akin to docker.
 
-Run the following code to your example using the CLI. The example is based on a youtube video url (optional):
+To start the API run:
 
 ```
-pipenv run python cli.py --invideo_filename '<your_file_name>' --video_url 'https://www.youtube.com/watch?v=<your_youtube_video>' --max_words_per_line 8
+pipenv run python main.py
 ```
 
-Fontsize, Font, Background Color and Text Color arguments are available:
+Then check the [landing page](http://127.0.0.1:8000).
 
-```
-pipenv run python cli.py --invideo_filename '<your_file>' --video_url 'https://www.youtube.com/watch?v=<your_youtube_video>' --max_words_per_line 8 --fontsize 28 --font "Arial-Bold" --bg_color None --text_color 'white'
-```
+From there you will see the [submit_video endpoint](http://127.0.0.1:8000/submit_video/) and the [documentation](http://127.0.0.1:8000/docs/)
 
-#### API
+**Tip**: on Linux or Mac localhost will resolve directly to 0.0.0.0 but on windows you will need to change it to 127.0.0.1
 
-A FastAPI API is also made available.
+### Command Line Interface
 
-To start the API run:
+Run the following code to use the CLI. The input file must be in mp4 format.
 
 ```
-pipenv run python main.py
+pipenv run python cli.py --invideo_filename '<your_file_name>' --max_words_per_line 8
 ```
 
-Then check the [landing page](http://127.0.0.1:8000). 
+Fontsize, Font, Background Color and Text Color arguments are available:
 
-From there you will see the [submit_video endpoint](http://127.0.0.1:8000/submit_video/) and the [documentation](http://127.0.0.1:8000/docs/)
+```
+pipenv run python cli.py --invideo_filename '<your_file>' --max_words_per_line 8 --fontsize 28 --font "Arial-Bold" --bg_color None --text_color 'white'
+```