Sunni Virtual Assistant 2.0
Version 0.1.5 Standalone BETA
================================

Overview
--------
Sunni Virtual Assistant 2.0 is a standalone PySide6 desktop interface for
Open WebUI running locally at:

    http://localhost:8080

Sunni provides a native desktop shell with theme support, browser session
controls, and persistent or private browsing modes.

Requirements
------------
- Linux
- Python 3
- python3-venv
- Open WebUI available at http://localhost:8080

Python dependencies are listed in requirements.txt and can be installed by
the included launch.sh utility.

Quick Start
-----------
Make the launcher executable if needed:

    chmod +x launch.sh

Then run:

    ./launch.sh

When launched from a terminal, launch.sh presents the Sunni options menu.
When called from a desktop launcher without an interactive terminal, it
starts Sunni directly.

Launcher Options
----------------
    ./launch.sh --menu
        Open the options menu.

    ./launch.sh --launch
        Launch Sunni from source.

    ./launch.sh --install
        Create the local .venv if needed and install/update dependencies.

    ./launch.sh --install-launch
        Install/update dependencies and launch Sunni.

    ./launch.sh --build
        Build the application with PyInstaller.

    ./launch.sh --build-launch
        Build the application and launch the compiled version.

    ./launch.sh --help
        Display launcher help.

Browser Sessions
----------------
Sunni creates two independent browser environments at runtime:

1. Persistent Browser
   - Disk-backed cache
   - Persistent cookies
   - Persistent HTML5/site storage
   - Runtime data is stored under data/web_profile/

2. Private Browser
   - Off-the-record profile
   - Memory cache
   - No persistent cookies
   - No persistent site storage

The Settings -> Browser Session control switches between the two existing
browser views without replacing a live QWebEngineProfile.

The default browser session mode is persistent.

If the setting is changed, Sunni creates:

    data/settings.json

Disabling persistence does not erase previously stored persistent browser
data. Re-enabling persistence returns to the persistent profile.

Runtime Data
------------
The release package intentionally contains no user-generated browser data,
cache, cookies, history, IndexedDB, session storage, or saved settings.

Sunni automatically creates the required data directories at runtime:

    data/
    data/web_profile/storage/
    data/web_profile/cache/

These directories are runtime data and should not be included when preparing
a clean distribution archive.

Themes
------
Included themes are stored in:

    assets/css/

Sunni automatically detects .qss themes in this directory and supported
nested theme folders.

Application Icon
----------------
The application icon is:

    assets/images/app_icon.png

Clean Distribution Contents
---------------------------
    Sunni_2.0/
    |-- app.py
    |-- launch.sh
    |-- requirements.txt
    |-- README.txt
    `-- assets/
        |-- css/
        |   |-- dark.qss
        |   |-- default.qss
        |   `-- light.qss
        `-- images/
            `-- app_icon.png

Excluded From Distribution
---------------------------
The following generated or local-use content should not be distributed:

- .venv/
- build/
- dist/
- __pycache__/
- *.pyc
- data/
- Browser cache and storage
- Cookies and browsing history
- Local session data
- PyInstaller temporary files

BETA Notice
-----------
Sunni Virtual Assistant 2.0 is currently a beta release. Features,
interface behavior, packaging, and workflow may change during development.
