====================================================
  VULNERD — Security Report Card Engine
  Setup Instructions
====================================================

WHAT YOU NEED FIRST
-------------------
  1. Python 3.10 or newer
     Download at: https://www.python.org/downloads/
     IMPORTANT: During install, check "Add Python to PATH"

  2. That's it.


FIRST-TIME SETUP (do this once)
---------------------------------
  1. Unzip this folder somewhere on your PC
     (e.g. Desktop or Documents)

  2. Open a terminal inside the Vulnerd folder:
     - Hold Shift + Right-click the folder
     - Select "Open in Terminal" or "Open PowerShell here"

  3. Run this command to install dependencies:
        pip install -r requirements.txt

  4. You're ready to go.


RUNNING THE APP
---------------
  Double-click:  Start Vulnerd.bat

  The app will open automatically in your browser.
  Keep the terminal window open while using the app.
  Press Ctrl+C in the terminal (or close it) to stop.


USING THE APP
-------------
  1. Export your Nessus scan as a CSV file
  2. Drag and drop the CSV onto the upload area
  3. Select Single Scan or Trend Analysis (2-5 files)
  4. (Optional) Pick your business type for compliance
  5. Click Analyze
  6. View your report card, then email or download the PDF
  7. Click the 🤓 button (bottom-right) to chat with AI
     about your results


API KEYS (in the .env file)
----------------------------
  The app uses AI to generate analysis. Keys are already
  configured in the .env file. If you need to update them:

  Open the .env file with Notepad and edit:
    GEMINI_API_KEY   — Google AI Studio (free tier available)
                       https://aistudio.google.com/apikey
    OPENAI_API_KEY   — OpenAI (ChatGPT fallback, optional)
                       https://platform.openai.com/api-keys
    EMAIL_SENDER     — Gmail address to send reports from
    EMAIL_PASSWORD   — Gmail App Password (not your login password)
                       https://myaccount.google.com/apppasswords


TROUBLESHOOTING
---------------
  "python is not recognized"
    → Python is not installed or not added to PATH.
      Re-install Python and check "Add Python to PATH".

  "pip is not recognized"
    → Same fix as above.

  "No module named X"
    → Run: pip install -r requirements.txt

  Browser doesn't open automatically
    → Manually go to: http://localhost:5001

  AI analysis shows an error
    → Gemini may be experiencing high demand.
      The app will retry automatically. Wait a moment and try again.


====================================================
  Built with Python, ReportLab, and Google Gemini
  Vulnerd — Your network's GPA.
====================================================
