From 767cec98f00f22fcda46323cb8e57ea1184bd6ee Mon Sep 17 00:00:00 2001 From: Adeel Ahmad Date: Sat, 10 Oct 2026 22:45:26 +0000 Subject: [PATCH] docs: describe the one-click default install and list the newer open PRs The README and Get started say the web installer can install with the defaults in one click (#331). "In progress" adds flagging instruction-like third-party text (#329), asking before the browser acts on what the assistant wrote (#333) and cloud model presets (#334). Co-Authored-By: Claude Opus 5.5 (1M context) Claude-Session: https://claude.ai/code/session_01HDx7PPUauyjMn1LZs8JAsS --- README.md | 18 +++++++++++------- docs/get-started.md | 3 ++- 2 files changed, 13 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index d7e878dba..136bddcab 100644 --- a/README.md +++ b/README.md @@ -19,12 +19,13 @@ cost-aware. curl -fsSL https://raw.githubusercontent.com/adeelahmad/lense/main/install.sh | sh ``` -That one line is all: it opens an installer in your browser that checks the computer, asks how Lens should run (in -Docker or a [microsandbox](docs/microsandbox.md) microVM), the AI model and its key and any extras, then installs -what's missing (Docker included), starts Lens and opens its setup page -([details](docs/get-started.md#the-web-installer)). Run it again to update. On Windows, run -`irm https://raw.githubusercontent.com/adeelahmad/lense/main/install.ps1 | iex` in PowerShell; or skip the terminal and -double-click the launcher for your system from the [latest release](https://github.com/adeelahmad/lense/releases/latest). +That one line is all: it opens an installer in your browser that checks the computer, then either installs with the +defaults in one click (with a model server it finds on the computer) or asks how Lens should run (in Docker or a +[microsandbox](docs/microsandbox.md) microVM), the AI model and its key and any extras. Either way it installs what's +missing (Docker included), starts Lens and opens its setup page ([details](docs/get-started.md#the-web-installer)). +Run it again to update. On Windows, run `irm https://raw.githubusercontent.com/adeelahmad/lense/main/install.ps1 | iex` +in PowerShell; or skip the terminal and double-click the launcher for your system from the +[latest release](https://github.com/adeelahmad/lense/releases/latest). [Deployment](docs/deployment.md) covers servers and Cloudron; there are also packages for [Synology](packaging/synology/README.md), [QNAP](packaging/qnap/README.md) and [Proxmox](proxmox/README.md). @@ -135,7 +136,10 @@ These are open pull requests, not yet part of Lens: ([#287](https://github.com/adeelahmad/lense/pull/287)), without Matterbridge; and the assistant's own email address, over IMAP and SMTP ([#314](https://github.com/adeelahmad/lense/pull/314)). - **Assistant safety:** running MCP servers that are programs (stdio) in a sandbox - ([#304](https://github.com/adeelahmad/lense/pull/304)). + ([#304](https://github.com/adeelahmad/lense/pull/304)); flagging third-party text that reads like instructions to an + AI ([#329](https://github.com/adeelahmad/lense/pull/329)); and asking before the browser opens or types what the + assistant wrote after reading a page ([#333](https://github.com/adeelahmad/lense/pull/333)). +- **Cloud model presets** in Settings and the setup wizard ([#334](https://github.com/adeelahmad/lense/pull/334)). - **Search:** a Similar tab, and similar content for text selected anywhere ([#307](https://github.com/adeelahmad/lense/pull/307)); NSFW pictures classified by a local model, per namespace ([#306](https://github.com/adeelahmad/lense/pull/306)). diff --git a/docs/get-started.md b/docs/get-started.md index c589d67e5..bd7667a02 100644 --- a/docs/get-started.md +++ b/docs/get-started.md @@ -26,7 +26,8 @@ On a first install run at a terminal (on Linux or a Mac with Python 3.8 or later above opens an installer in your browser instead of asking anything in the terminal: 1. **This computer**: the system, memory, free disk, whether Docker is there and running, and whether microsandbox can - run. + run. On a first install, **Install with the defaults** skips the next steps: it picks a model server it finds on + the computer, if there is one, and installs straight away. **Choose options** goes through them. 2. **How it runs**: Docker or [microsandbox](microsandbox.md), the full or lean edition (lean is picked on a computer with less than 4 GB of memory, such as a Raspberry Pi), the folder, the port, and whether other devices on the network may reach it. It lists what it will install; when that needs administrator rights, it asks for your