Restore illustrated README project introduction

This commit is contained in:
Dandaedre 2026-11-16 11:15:34 +01:00
parent 3351041cd4
commit cfde3411af
2 changed files with 78 additions and 9 deletions

View File

@ -1,7 +1,8 @@
<p align="center">
<img src="crates/canvas-pilot/assets/app-icon.png" width="80" height="80" alt="Canvas Pilot icon">
<img src="crates/canvas-pilot/assets/app-icon.png" width="96" height="96" alt="Canvas Pilot icon">
</p>
<h1 align="center">Canvas Pilot</h1>
<p align="center"><strong>Compose your screen layout. Frame every layer. Bring it to the switcher.</strong></p>
<p align="center">
<a href="docs/canvas-pilot/changelog.md"><img src="https://assets.dandaedre.com/coverage/idle-org/canvas-pilot/main/version.svg" alt="Version"></a>
@ -9,15 +10,79 @@
<a href="docs/development/ci.md"><img src="https://assets.dandaedre.com/coverage/idle-org/canvas-pilot/main/coverage.svg" alt="Coverage"></a>
</p>
A desktop layout editor for presentations and live events. Arrange, resize and crop
screen layers offline, exchange layouts with drawing tools, and review geometry
transfers to supported Analog Way Midra and Aquilon switchers.
<p align="center">
<a href="https://books.dandaedre.com/manuals/canvas-pilot/docs/canvas-pilot/guide/install.html"><strong>Install and update</strong></a> ·
<a href="https://books.dandaedre.com/manuals/canvas-pilot/">Read the manual</a> ·
<a href="https://proxy.dandaedre.com/gitea/idle-org/canvas-pilot/releases">Releases</a> ·
<a href="https://proxy.dandaedre.com/gitea/idle-org/canvas-pilot/issues">Report an issue</a>
</p>
**[Read the manual](https://books.dandaedre.com/manuals/canvas-pilot/)** ·
[Install and update](https://books.dandaedre.com/manuals/canvas-pilot/docs/canvas-pilot/guide/install.html) ·
[Releases](https://proxy.dandaedre.com/gitea/idle-org/canvas-pilot/releases) ·
[Report an issue](https://proxy.dandaedre.com/gitea/idle-org/canvas-pilot/issues)
Canvas Pilot is a desktop layout editor for presentations and live events. Arrange
slides, cameras and other content as layers on a screen, give them precise sizes
and positions, and crop each picture into place. Prepare everything offline,
exchange layouts with drawing tools, or connect to a supported **Analog Way Midra
or Aquilon** to load and send layer geometry.
[Development](docs/development/README.md) · [Changelog](docs/canvas-pilot/changelog.md) · [MIT license](LICENSE)
Canvas Pilot prepares the layout; your presentation switcher renders the live output.
You can use the editor and file exchange without any connected equipment.
<!-- Screenshot recipe: docs/canvas-pilot/images/capture.md#01-workspacepng -->
[![Workspace showing a Slides and Presenter layout, pixel measurements and layer controls](docs/canvas-pilot/images/01-workspace.png)](docs/canvas-pilot/guide/quickstart.md)
*Slides + Presenter on a Full HD canvas. Screenshots predate the Canvas Pilot
rename and still show the former “Midra Layout” name.*
## From an idea to a screen layout
1. **Set the stage.** Choose a canvas size or import geometry. Add a reference
image to position layers against your design.
2. **Arrange and frame.** Drag, resize, snap and align layers. Enter exact pixel
measurements, organize layers in folders, and adjust the crop visually.
3. **Save or exchange.** Keep an editable project, export a layout for another tool,
or start from the supplied Full HD and 4K templates.
4. **Transfer when ready.** Connect to a supported device, review mappings and
explicitly load or send. Ordinary editing stays local.
[**Walk through your first layout →**](docs/canvas-pilot/guide/quickstart.md)
## Tools for getting the picture right
| Arrange the screen | Frame the content | Work with the device |
| --- | --- | --- |
| Exact sizes and positions | Visual crop, zoom and offset | Load existing layer geometry |
| Snapping, guides and alignment | Reference images and input stills | Review layer-to-device mappings |
| Multi-selection and group resizing | Advanced layer fit and Midra masks | Send selected, folder or all layers |
| Folders, visibility and undo/redo | Saved projects and recovery | Update changed parameters efficiently |
<details>
<summary><strong>See the crop workspace</strong></summary>
<!-- Screenshot recipe: docs/canvas-pilot/images/capture.md#03-croppng -->
![Crop controls and on-canvas content framing in the earlier Midra Layout interface](docs/canvas-pilot/images/03-crop.png)
Adjust the picture inside its layer while keeping the layout in view.
[Explore crop controls and fit modes →](docs/canvas-pilot/guide/formats-and-crop.md)
</details>
## Bring your layout with you
Exchange layouts with vector editors, diagrams.net, CAD tools, PowerPoint and
Figma. Choose the file or clipboard workflow that preserves what you need using
the [**format feature matrix**](docs/canvas-pilot/guide/format-matrix.md).
[Download starter templates](docs/templates/canvas-pilot/catalog.md) ·
[Import and export guide](docs/canvas-pilot/guide/files.md)
For **Midra 4K** and **Aquilon / LivePremier**, see the
[device guide](docs/canvas-pilot/guide/device.md) for supported profiles, setup and
feature limits. Support depends on model and firmware; Aquilon validation uses
the documented standalone emulator profile.
---
[**Full manual**](https://books.dandaedre.com/manuals/canvas-pilot/) ·
[Development](docs/development/README.md) ·
[Changelog](docs/canvas-pilot/changelog.md) · [MIT license](LICENSE)
Independent software, not affiliated with Analog Way.

View File

@ -4,6 +4,10 @@
## Unreleased
- Restored the illustrated main README with a workspace preview, feature overview
and layout workflow. Kept status badges at the top, detailed instructions in the
book and task lists behind the Development link.
- New project saves suggest `.pilot.json` (Canvas Pilot). Open project accepts
any `.json` filename and validates its contents, including legacy `.midra.json`
projects. Files are not renamed automatically. Updated the manual and checked