Skip to content

Commit

Permalink
docs: updating wording in readme.md (#396)
Browse files Browse the repository at this point in the history
* docs: updating wording in readme.md

* docs: adding container otherwise misleading
  • Loading branch information
cyfyifanchen authored Nov 11, 2024
1 parent 6d1ae5b commit bf24885
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,13 +117,13 @@ You will need to uncheck "Use Rosetta for x86_64/amd64 emulation on Apple Silico
#### 1. Modify config files
In the root of the project, use `cp` command to create `.env` from the [ .env.example ](https://github.com/TEN-framework/ten-agent/blob/main/.env.example).

It will be used to store environment variables for `docker compose` later, and if you change it, you will need to `source .env` again for the changes to take effect.
It will be used to store environment variables for `docker compose` later, and if you change it, you will need to `source .env` again in the container for the changes to take effect.
```bash
cp ./.env.example ./.env
```

#### 2. Setup API keys
Open the `.env` file and fill in the `keys`.
Open the `.env` file and fill in the `keys`. We recommend using [ Deepgram ASR ](https://deepgram.com/) and [ FishAudio TTS ](https://fish.audio/) as they are free to sign up for and offer free credits. Of course, you can also use other services, see the list in [.env.example](https://github.com/TEN-framework/ten-agent/blob/main/.env.example).
```bash
# Agora App ID
# Agora App Certificate(only required if enabled in the Agora Console)
Expand Down

0 comments on commit bf24885

Please sign in to comment.