marquesafonso commited on
Commit
f489fc8
·
1 Parent(s): 250eb65

improve readme

Browse files
Files changed (1) hide show
  1. README.md +9 -12
README.md CHANGED
@@ -14,15 +14,14 @@ You'll need to install [docker](https://www.docker.com/products/docker-desktop/)
14
 
15
  Then, follow the steps below.
16
 
17
- 1. clone the repo
18
- ```{bash}
19
- git clone [email protected]:marquesafonso/multilang-asr-captioner.git
20
- ```
21
- 2. Build and run the container using docker-compose
22
-
23
- ```{bash}
24
- docker compose up
25
- ```
26
 
27
  Check the [landing page](http://127.0.0.1:8000).
28
 
@@ -52,9 +51,7 @@ Note that this assumes a proper Git installation and ssh key configuration.
52
 
53
  ### API
54
 
55
- A FastAPI API is available. This is the easiest way to use the program locally, akin to docker.
56
-
57
- To start the API run:
58
 
59
  ```
60
  pipenv run python main.py
 
14
 
15
  Then, follow the steps below.
16
 
17
+ 1. clone the repo
18
+ ```{bash}
19
+ git clone [email protected]:marquesafonso/multilang-asr-captioner.git
20
+ ```
21
+ 2. Build and run the container using docker-compose
22
+ ```{bash}
23
+ docker compose up
24
+ ```
 
25
 
26
  Check the [landing page](http://127.0.0.1:8000).
27
 
 
51
 
52
  ### API
53
 
54
+ A FastAPI API is available. To start the API locally, run:
 
 
55
 
56
  ```
57
  pipenv run python main.py