README desktop section: the gist up front, the rest in a fold-out
Output 3 opens with three sentences (browser to desktop with the same code, Rudder as the working Linux proof, its private-by-design goal) and one screenshot. How it works, Rudder's goal in full, and what isn't run yet move into a details fold-out. The two Studio bullets go back to one-line gists.
This commit is contained in:
parent
6dfaf630e1
commit
095aa67fbf
1 changed files with 22 additions and 26 deletions
48
README.md
48
README.md
|
|
@ -259,12 +259,9 @@ If you build with AI agents, this repo is made for you:
|
|||
updating the moment you save.
|
||||
- **Speak instead of typing.** Rudder, an offline voice-to-text tool, sits as a corner widget in the
|
||||
Studio: look at a plugin, say what you see, and hand the text to your agent. Nothing leaves your
|
||||
computer. Rudder also runs as its own desktop app: the Linux app works and is used to dictate the
|
||||
work on many of these maps.
|
||||
- **One plugin, several outputs.** The same code ships as a web embed, a mobile app or a desktop app.
|
||||
Rudder shows the whole path: you run it in your browser on the development server, then
|
||||
`bun run desktop:build rudder-voice` ships that same code as a desktop app (see
|
||||
[HOWTO-build-the-desktop-app](./documentation/HOWTO-build-the-desktop-app.md)).
|
||||
computer. It also runs as its own desktop app.
|
||||
- **One plugin, several outputs.** The same code ships as a web embed, a mobile app or a desktop app
|
||||
([the desktop app](#output-3--the-desktop-app--works-today)).
|
||||
- **Build together.** [Run it in the cloud](#run-it-in-the-cloud) gives a whole team one shared dev
|
||||
server.
|
||||
|
||||
|
|
@ -617,18 +614,24 @@ bun run phone # builds the app and installs it on a phone or emulator
|
|||
|
||||
### Output 3 — the desktop app ✅ works today
|
||||
|
||||
**Run it in your browser, then ship the same code as a desktop app.** What you build and try on the
|
||||
development server (`bun run dev`) is what ships to the desktop: [Tauri](https://tauri.app) wraps the
|
||||
built folder in a small Rust program that runs on your own computer. There is no second code base.
|
||||
|
||||
**Rudder, the offline voice-to-text plugin, proves it.** It runs as a corner widget in the Plugin
|
||||
Studio and as its own desktop app, built with `bun run desktop:build rudder-voice`
|
||||
([HOWTO-build-the-desktop-app](./documentation/HOWTO-build-the-desktop-app.md)). The Linux app works and
|
||||
is used to dictate the work on many of these maps: look at a plugin, say what you see, and hand the
|
||||
text to an agent. Nothing leaves the computer.
|
||||
**Run it in your browser, then ship the same code as a desktop app.** [Tauri](https://tauri.app) wraps
|
||||
it in a small Rust program that runs on your computer. Rudder, the offline voice-to-text plugin, is the
|
||||
proof: its Linux desktop app works and is used to dictate the work on many of these maps. Its goal is
|
||||
private voice-to-text that you own: offline, no telemetry, no cloud.
|
||||
|
||||

|
||||
|
||||
<details>
|
||||
<summary><b>More: how it works, Rudder's goal, and what isn't run yet</b></summary>
|
||||
|
||||
**How it works.** What you build and try on the development server (`bun run dev`) is what ships to
|
||||
the desktop; there is no second code base. Rudder runs as a corner widget in the Plugin Studio and as
|
||||
its own desktop app, built with `bun run desktop:build rudder-voice`
|
||||
([HOWTO-build-the-desktop-app](./documentation/HOWTO-build-the-desktop-app.md)): look at a plugin, say
|
||||
what you see, and hand the text to an agent. The map app runs as a desktop app the same way:
|
||||
|
||||

|
||||
|
||||
**Rudder's goal, from the start: private voice-to-text that you own.**
|
||||
|
||||
- **Offline, with no telemetry and no cloud.** Your own code and your own self-hosted speech model
|
||||
|
|
@ -641,17 +644,10 @@ text to an agent. Nothing leaves the computer.
|
|||
`backend/rudder-engine/` only from people you trust, and have a second person read every one.
|
||||
- **Planned: an egress monitor** that shows you, as it runs, that Rudder sends no data out to anyone.
|
||||
|
||||
**The map app runs as a desktop app the same way.**
|
||||
|
||||

|
||||
|
||||
<details>
|
||||
<summary><b>More about the desktop app</b></summary>
|
||||
|
||||
Tauri builds a Linux app and a `.deb` installer today. The macOS and Windows builds are set up but
|
||||
have not been run yet ([the HOWTO](./documentation/HOWTO-build-the-desktop-app.md) says which steps are
|
||||
proven). The desktop build runs on demand with the commands below; the automatic production build
|
||||
doesn't make it yet. The Research Gallery could become a strong desktop app too.
|
||||
**What isn't run yet.** Tauri builds a Linux app and a `.deb` installer today. The macOS and Windows
|
||||
builds are set up but have not been run ([the HOWTO](./documentation/HOWTO-build-the-desktop-app.md)
|
||||
says which steps are proven). The desktop build runs on demand with the commands below; the automatic
|
||||
production build doesn't make it yet. The Research Gallery could become a strong desktop app too.
|
||||
|
||||
```bash
|
||||
bun run check:tauri # checks the desktop setup — needs no Rust tools
|
||||
|
|
|
|||
Loading…
Reference in a new issue