docs: add Augmented Canvas full name and macOS .app bundle instructions

This commit is contained in:
David Ibia
2026-02-09 21:20:28 +01:00
parent 233cb5798c
commit e8ec44d961

View File

@@ -1,10 +1,10 @@
# agcanvas # agcanvas — Augmented Canvas
A system-level interactive canvas for agent-human collaboration. Draw shapes, paste SVGs from Figma, render Mermaid diagrams, and let AI agents understand your designs via MCP or WebSocket. A system-level interactive canvas for agent-human collaboration. Draw shapes, paste SVGs from Figma, render Mermaid diagrams, and let AI agents understand your designs via MCP or WebSocket.
## What is this? ## What is this?
agcanvas bridges the gap between visual design and code generation. It's a **collaboration surface** for humans and AI agents — draw your ideas, paste designs, and let agents see exactly what's on the canvas. agcanvas (short for **Augmented Canvas**) bridges the gap between visual design and code generation. It's a **collaboration surface** for humans and AI agents — draw your ideas, paste designs, and let agents see exactly what's on the canvas.
``` ```
┌──────────────────────────────────────────────────────────────┐ ┌──────────────────────────────────────────────────────────────┐
@@ -97,6 +97,39 @@ agcanvas --help
agcanvas-mcp --help agcanvas-mcp --help
``` ```
### macOS `.app` Bundle
agcanvas compiles into a native macOS application. The release binary (`target/release/agcanvas`) runs directly, but if you want a proper `.app` bundle you can double-click in Finder or drag to `/Applications`, use [`cargo-bundle`](https://github.com/burtonageo/cargo-bundle):
1. **Install cargo-bundle:**
```bash
cargo install cargo-bundle
```
2. **Add bundle metadata** to `crates/agcanvas/Cargo.toml`:
```toml
[package.metadata.bundle]
name = "Augmented Canvas"
identifier = "com.agcanvas.app"
icon = ["assets/icon.icns"]
category = "public.app-category.developer-tools"
short_description = "Interactive canvas for agent-human collaboration"
```
3. **Bundle it:**
```bash
cargo bundle --release -p agcanvas
```
This produces `target/release/bundle/osx/Augmented Canvas.app`.
4. **Install:**
```bash
cp -r "target/release/bundle/osx/Augmented Canvas.app" /Applications/
```
> **Note:** The raw `cargo build --release` binary already works as a native macOS app — `cargo-bundle` just wraps it in a `.app` bundle with an icon, metadata, and Finder integration. No code changes are needed.
### Requirements ### Requirements
- Rust 1.70+ - Rust 1.70+