From c472d616060e18a64771186659896ed40211d586 Mon Sep 17 00:00:00 2001 From: saicharankandukuri Date: Fri, 30 Oct 2026 13:31:13 +0530 Subject: [PATCH] chore: cleanup readme. --- README.md | 2 +- docs/PRODUCT_SCOPE.md | 70 ------------------------------------------- 2 files changed, 1 insertion(+), 71 deletions(-) delete mode 100644 docs/PRODUCT_SCOPE.md diff --git a/README.md b/README.md index 9e1da0f..c51bd40 100644 --- a/README.md +++ b/README.md @@ -47,7 +47,7 @@ installed, uDroid can check for updates from **About**. User guide: [Using uDroid](docs/USER_GUIDE.md). Developer reference: [builds and releases](docs/DEVELOPMENT.md), -[product scope](docs/PRODUCT_SCOPE.md), [Linux systems](docs/DISTRIBUTION_CATALOGUE.md), +[Linux systems](docs/DISTRIBUTION_CATALOGUE.md), [Linux apps](docs/LINUX_APPLICATION_LAUNCHER.md), [desktop](docs/X11_RUNTIME_ARCHITECTURE.md), [audio](docs/AUDIO_RUNTIME.md), [updates](docs/APP_UPDATES.md), and [performance](docs/PERFORMANCE.md). diff --git a/docs/PRODUCT_SCOPE.md b/docs/PRODUCT_SCOPE.md deleted file mode 100644 index 582935c..0000000 --- a/docs/PRODUCT_SCOPE.md +++ /dev/null @@ -1,70 +0,0 @@ -# uDroid Android product scope - -## Product - -uDroid is a general Android application for installing, booting, stopping, -repairing, and interacting with Linux distributions through PRoot. It replaces -a terminal-first workflow with an Android-first lifecycle and UI. - -## One operation, two levels of detail - -Every long-running operation is designed for both ordinary and expert users: - -- The default surface answers what is happening, how far it has progressed, - and whether the user needs to act. -- **Show terminal** opens a bottom drawer with the exact technical event - stream for an operation. The dedicated **Terminal** surface attaches to the - running distro's interactive PTY. -- The friendly view and terminal are projections of one service-owned state - machine. They must never run separate commands or disagree about status. - -This progressive-disclosure pattern applies to installation, boot, repair, -package updates, exports, and optional hardware-profile setup. - -The main journey is: - -1. Open uDroid. -2. Choose a compatible Linux distribution and session type. -3. Download and install it with resumable, real progress. -4. Tap **Boot**. -5. Use its shell or graphical desktop. -6. Stop, repair, update, export files, or inspect diagnostics from the app. - -## Platform layers - -```mermaid -flowchart TB - App["uDroid Android app"] --> Catalog["Distro catalogue"] - App --> Installer["Resumable rootfs installer"] - App --> Supervisor["Runtime supervisor"] - Supervisor --> Proot["PRoot + distro session"] - Supervisor --> Shell["Termux PTY session"] - Shell --> App - App --> X11["Optional graphical session"] - Installer --> Events["Shared operation events"] - Events --> Friendly["Friendly progress UI"] - Events --> Terminal["Terminal and logs drawer"] - Supervisor --> Profiles["Optional device profiles"] - Profiles --> Generic["Generic CPU presentation"] - Profiles --> Tensor["Tensor G1 experimental acceleration"] - Profiles --> Future["Future device-specific integrations"] -``` - -## Non-goals for the core app - -- Requiring a Tensor phone, Mali GPU, `/dev/mali0`, or patched Mesa. -- Pretending every distribution has or needs a full desktop. -- Making GNOME, KDE, Firefox, games, or hardware video the basic health gate. -- Requiring Termux or Termux:X11 as separately installed applications. -- Treating SSH or ADB as a product control plane. - -## Relationship to existing repositories - -- `RandomCoderOrg/fs-manager-udroid` is the behavior and distro-management - source. Its typed Go manifest, rootfs, and PRoot packages are candidates for - reuse behind a stable Android bridge. -- `tensor-g1-proot-gpu` is an optional experimental hardware profile and a - source of graphics/media artifacts. It does not define the product. -- Termux and Termux:X11 remain important upstream code sources for PTY, - terminal, input, and X11 behavior, but the final uDroid app owns its own UID, - paths, lifecycle, and user experience.