docs: readme

l3vels · Sep 15, 2023 · f3f78e1 · f3f78e1
1 parent 6a9d9c7
commit f3f78e1
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -145,16 +145,22 @@ L3AGI offers a robust set of functionalities that empower you to design, supervi
    cd L3AGI
    ```
 
-3. **Setup Git Hooks**
+3. **Create `.env` file from `.env.example` in root directory**
+
+   ```bash
+   cp .env.example .env
+   ```
+
+   Configure `.env` file with your own values.
+
+4. **Setup Git Hooks**
 
    ```bash
    chmod +x setup.sh
    ./setup.sh
    ```
 
-   This will build and start both the React UI and FastAPI services.
-
-4. 🐳 **Run Docker Compose:**
+5. 🐳 **Run Docker Compose:**
 
    ```bash
    docker-compose up --build

diff --git a/apps/server/.env.example b/apps/server/.env.example
@@ -13,7 +13,7 @@ DB_PASS=postgres
 AZURE_PUBSUB_CONNECTION_STRING=
 AZURE_PUBSUB_HUB_NAME=hub
 
-# Configure Zep for chat memory
+# Configure Zep for chat memory. Quickstart: https://docs.getzep.com/deployment/quickstart/
 ZEP_API_URL=
 ZEP_API_KEY=