======================================================================
MU-QTBROWSER v1.0.0 - Lightweight IPC-coupled Web Container & Controller
======================================================================

1. WHAT IS IT AND WHAT IS IT GOOD FOR?
----------------------------------------------------------------------
mu-qtbrowser is a modular, high-performance web container architecture 
specifically designed for lightweight Linux desktop environments like IceWM, 
Openbox, or Fluxbox (such as Linux Mint, antiX, MX Linux, or Puppy Linux).

It decouples the heavy Chromium-based rendering engine (Qt6 WebEngine) from 
the lightweight desktop UI controller (Vala/GTK3) using isolated UNIX domain 
sockets. This prevents event-loop collisions, ensures minimal memory overhead 
for the frontend, and allows seamless integration of full web apps, local 
dashboards, or streaming interfaces directly into custom window managers 
without bloated browser chrome.


2. ARCHITECTURE & TECHNOLOGIES
----------------------------------------------------------------------
- Backend (mu-browser): C++ / Qt6 (QWebEngineView) running an internal 
  QLocalServer listening on "/tmp/mu-browser.sock". Handles full HTTPS 
  navigation, link redirection, and history (back/forward/reload).
- Frontend (mu-controller): Vala / GTK3 native toolbar featuring back, 
  forward, reload buttons, an address bar, and a Go button, communicating 
  with the backend via line-delimited JSON commands over UNIX sockets.
- Launcher Wrapper (launch-mu-browser.sh): A robust shell script that cleans 
  up old socket files, starts the Qt backend, waits for socket readiness, 
  and launches the Vala controller.


3. BUILD AND INSTALLATION COMMANDS
----------------------------------------------------------------------
To compile both components:
  make

To install binaries and wrapper script system-wide (requires root):
  sudo make install

To pack a clean source distribution tarball:
  make source

To clean up build files:
  make clean


4. SYSTEM REQUIREMENTS & DEPENDENCIES
----------------------------------------------------------------------

--- A. Linux Mint 22.3 / Ubuntu 24.04 (and derivatives) ---
* Build Dependencies:
  sudo apt install cmake build-essential qt6-base-dev qt6-webengine-dev valac libgtk-3-dev libglib2.0-dev libgio-2.0-dev
* Runtime Dependencies:
  sudo apt install libqt6webenginewidgets6 libgtk-3-0 libglib2.0-0

--- B. Debian Trixie / Bookworm ---
* Build Dependencies:
  sudo apt install cmake build-essential qt6-base-dev qt6-webengine-dev valac libgtk-3-dev libglib2.0-dev
* Runtime Dependencies:
  sudo apt install libqt6webenginewidgets6 libgtk-3-0

--- C. Puppy Linux (Bookwormpup64) ---
* Build Dependencies (via PPM or apt if enabled):
  cmake, gcc, g++, qt6-base-dev, qt6-webengine-dev, vala, gtk+3-dev
* Runtime Dependencies:
  qt6-webengine, gtk+3, glib

--- D. Manjaro / Arch Linux ---
* Build Dependencies:
  sudo pacman -S cmake base-devel qt6-base qt6-webengine vala gtk3
* Runtime Dependencies:
  sudo pacman -S qt6-webengine gtk3


5. USAGE
----------------------------------------------------------------------
You can launch the complete browser suite seamlessly using the provided 
wrapper script:
   ./launch-mu-browser.sh

Or, if installed system-wide:
   launch-mu-browser.sh
======================================================================