940d0de5b6
- Update comparison tables: 78 tools (was 75), SVG export no longer a Penpot advantage, renderer LOC updated to ~3,200 after split into 10 files - Update figma-comparison: Rename layers ✅, SVG export ✅, +Copy/Paste as, +Tailwind export, +Stroke align, +per-side stroke weights; coverage 88/152 → 94/158 - Add What's Next roadmap to architecture.md: AI providers, figma-use tool set, CI tooling, prototyping, CSS Grid, PDF export, .fig fidelity - Update user-guide: SVG in export format table, Copy/Paste as submenu, stroke align + per-side weights, layer inline rename, mobile drawer, Code tab format toggle - Fix keyboard shortcuts: ⌘N/⌘T/⌘W ✅, ⌘\ ✅, add ⇧⌘C ✅ - Expand MCP tools reference from ~25 to all 78 tools in full category tables - Add Homebrew tap install to Getting Started - Add new features.md sections: SVG export, Copy/Paste as, stroke align, mobile/PWA, Tailwind JSX export, Google Fonts fallback, auto-save toggle, Homebrew tap, layer rename, renderer profiler - Full locale sync for DE, ES, FR, IT, PL: all 7 files updated in each locale
110 lines
2.5 KiB
Markdown
110 lines
2.5 KiB
Markdown
# Getting Started
|
|
|
|
## Try Online
|
|
|
|
OpenPencil runs in the browser — no installation required. Open [app.openpencil.dev](https://app.openpencil.dev) to start designing.
|
|
|
|
## Download Desktop App
|
|
|
|
Pre-built binaries for macOS, Windows, and Linux are available on the [releases page](https://github.com/open-pencil/open-pencil/releases/latest).
|
|
|
|
| Platform | Download |
|
|
|----------|----------|
|
|
| macOS (Apple Silicon) | `.dmg` (aarch64) |
|
|
| macOS (Intel) | `.dmg` (x64) |
|
|
| Windows (x64) | `.msi` / `.exe` |
|
|
| Windows (ARM) | `.msi` / `.exe` |
|
|
| Linux (x64) | `.AppImage` / `.deb` |
|
|
|
|
|
|
## macOS via Homebrew
|
|
|
|
```sh
|
|
brew install open-pencil/tap/open-pencil
|
|
```
|
|
|
|
This installs the latest signed release for macOS (Apple Silicon and Intel). The tap is auto-updated on each release.
|
|
|
|
## Building from Source
|
|
|
|
### Prerequisites
|
|
|
|
- [Bun](https://bun.sh/) (package manager and runtime)
|
|
- [Rust](https://rustup.rs/) (for desktop app only)
|
|
|
|
## Installation
|
|
|
|
```sh
|
|
git clone https://github.com/open-pencil/open-pencil.git
|
|
cd open-pencil
|
|
bun install
|
|
```
|
|
|
|
## Development Server
|
|
|
|
```sh
|
|
bun run dev
|
|
```
|
|
|
|
Opens the editor at `http://localhost:1420`.
|
|
|
|
## Available Scripts
|
|
|
|
| Command | Description |
|
|
|---------|-------------|
|
|
| `bun run dev` | Dev server with HMR |
|
|
| `bun run build` | Production build |
|
|
| `bun run check` | Lint (oxlint) + typecheck (tsgo) |
|
|
| `bun run test` | E2E visual regression (Playwright) |
|
|
| `bun run test:update` | Regenerate screenshot baselines |
|
|
| `bun run test:unit` | Unit tests (bun:test) |
|
|
| `bun run docs:dev` | Documentation dev server |
|
|
| `bun run docs:build` | Build documentation site |
|
|
|
|
## Desktop App (Tauri)
|
|
|
|
The desktop app requires Rust and platform-specific prerequisites.
|
|
|
|
### macOS
|
|
|
|
```sh
|
|
xcode-select --install
|
|
cargo install tauri-cli --version "^2"
|
|
bun run tauri dev
|
|
```
|
|
|
|
### Windows
|
|
|
|
1. Install [Rust](https://rustup.rs/) with `stable-msvc` toolchain:
|
|
```sh
|
|
rustup default stable-msvc
|
|
```
|
|
2. Install [Visual Studio Build Tools](https://visualstudio.microsoft.com/visual-cpp-build-tools/) with "Desktop development with C++" workload
|
|
3. WebView2 is pre-installed on Windows 10 (1803+) and Windows 11
|
|
4. Run:
|
|
```sh
|
|
bun run tauri dev
|
|
```
|
|
|
|
### Linux
|
|
|
|
Install system dependencies (Debian/Ubuntu):
|
|
|
|
```sh
|
|
sudo apt install libwebkit2gtk-4.1-dev build-essential curl wget file \
|
|
libxdo-dev libssl-dev libayatana-appindicator3-dev librsvg2-dev
|
|
```
|
|
|
|
Then:
|
|
|
|
```sh
|
|
bun run tauri dev
|
|
```
|
|
|
|
### Build for Distribution
|
|
|
|
```sh
|
|
bun run tauri build # Current platform
|
|
bun run tauri build --target universal-apple-darwin # macOS universal
|
|
```
|