Updated how-to instructions.

README.md

@@ -13,58 +13,66 @@ Resumate is a simple web app that helps you generate a tailored resume for a spe
 
 ---
 
-## 🚀 Quickstart (Recommended: GitHub Codespaces)
+## Quickstart (Recommended: GitHub Codespaces)
 
-1. **Open in Codespaces**
-   - Click the "Code" button on GitHub and select "Open with Codespaces".
+1. **Fork this repository**
+   - Click the "Fork" button on GitHub to create your own copy of the repository.
+2. **Add API keys as secrets**
+   - In your fork, go to **Settings > Secrets and variables > Codespaces**.
+   - Add secrets named `OPENAI_API_KEY` and `MODAL_API_KEY` with your API keys as values.
+   - These will be available as environment variables in your Codespace.
+3. **Start a Codespace**
+   - Click the "Code" button on your fork and select "Open with Codespaces".
    - Codespaces will automatically set up the environment.
-2. **Install dependencies** (if not pre-installed):
-   ```bash
-   pip install -r requirements.txt
-   ```
-3. **Run the app:**
-   ```bash
-   python resumate.py
-   ```
 4. **Open the provided URL** in your browser to use the Gradio UI.
 
 ---
 
-## 🖥️ Running Locally with Virtualenv
+## Running Locally with Virtualenv
 
-1. **Clone the repository:**
+
+> **Note:** The following instructions are for Linux systems. Python 3.10 or greater is required.
+
+1. **Fork this repository:**
+   - Click the "Fork" button on GitHub to create your own copy of the repository.
+2. **Clone your fork:**
    ```bash
-   git clone https://github.com/gperdrizet/resumate.git
+   git clone https://github.com/<your-username>/resumate.git
    cd resumate
    ```
-2. **Create and activate a virtual environment:**
+3. **Create a virtual environment:**
    ```bash
    python3 -m venv .venv
+   ```
+4. **Set your API keys as environment variables:**
+   Add your API keys to `.venv/bin/activate`:
+    ```bash
+    export OPENAI_API_KEY=your_openai_api_key
+    export MODAL_API_KEY=your_modal_api_key
+    ```
+5. **Activate the virtual environment:**
+   ```bash
    source .venv/bin/activate
    ```
-3. **Install dependencies:**
+6. **Install dependencies:**
    ```bash
    pip install -r requirements.txt
    ```
-4. **Run the app:**
+7. **Run the app:**
    ```bash
    python resumate.py
    ```
-5. **Open the provided URL** in your browser to use the Gradio UI.
+8. **Open the provided URL** in your browser to use the Gradio UI.
 
 ---
 
-## 📄 LinkedIn PDF Export Instructions
+## LinkedIn PDF Export Instructions
 1. Go to your LinkedIn profile page
 2. Click the "More" button (three dots)
 3. Select "Save to PDF"
 4. Wait for the download
 5. Upload the PDF in the app
 
----
-
-## License
-MIT License
 ---
 title: Resumate
 colorFrom: blue