Update README for implemented MVP and build instructions.
Co-authored-by: Cursor <cursoragent@cursor.com>
@@ -6,7 +6,48 @@ Cross-platform designer for POS (point-of-sale) receipt documents. Edit template
6
6
7
7
## Status
8
8
9
Pre-implementation — design phase. See [docs/](docs/) for specifications.
9
**v0.1.0 MVP** — Rust + egui app with editor, preview, help, `.pos` files, parameters, and USB-serial printing.
10
11
## Build and run
12
13
```bash
14
cargo test # 20 unit tests
15
cargo run # launch the designer
16
cargo build --release
17
```
18
19
**Linux:** add your user to the `dialout` group for USB-serial printer access.
20
21
## Releases (GitLab CI)
22
23
| Platform | Artifact | Install |
24
|----------|----------|---------|
25
| Linux | `.deb` (amd64) | `sudo dpkg -i posprint_*_amd64.deb` then `sudo apt-get install -f` |
26
| Windows | `posprint.exe` | Download from GitLab release job artifacts |
27
28
Tag a version (e.g. `v0.1.0`) to trigger release builds.
29
30
## Features
31
32
- Markdown-like template editor with live preview
33
- Page width: auto-scale or fixed width (mm)
34
- Save and load `.pos` files
35
- Parameter tokens (`${DocumentNumber}`) with print-time popup and value reuse
36
- Barcodes, QR codes, and images (including parameterized content)
37
- Print to USB-serial POS printers via raw ESC/POS bytes
38
- In-app **Help** tab (from [docs/HELP.md](docs/HELP.md))
39
40
## Dependencies (minimal)
41
42
| Crate | Why |
43
|-------|-----|
44
| `eframe` / `egui` | Native UI |
45
| `serde` / `serde_json` | `.pos` file format |
46
| `serialport` | USB-serial printer I/O |
47
| `image` | Load PNG/JPEG for `@image` |
48
| `rfd` | Native open/save dialogs |
49
50
ESC/POS encoding is implemented in-tree.
10
51
11
52
## Design documents
12
53
@@ -21,12 +62,7 @@ Pre-implementation — design phase. See [docs/](docs/) for specifications.
21
62
22
63
## Planned features
23
64
24
- Markdown-like template editor with live preview
25
- Page width: auto-scale to window or fixed width (mm)
26
- Save and load `.pos` files
27
- Parameter tokens (`${DocumentNumber}`) with print-time popup and value reuse
28
- Barcodes, QR codes, and images (including parameterized content)
29
- Print to USB / Bluetooth POS printers via raw byte streams
65
- Bluetooth printer support (deferred)
30
66
31
67
## Quick feasibility summary
32
68
@@ -6,7 +6,48 @@ Cross-platform designer for POS (point-of-sale) receipt documents. Edit template6
6
7
## Status
7
## Status
8
8
9
Pre-implementation — design phase. See [docs/](docs/) for specifications.
9
**v0.1.0 MVP** — Rust + egui app with editor, preview, help, `.pos` files, parameters, and USB-serial printing.
10
11
## Build and run
12
13
```bash
14
cargo test # 20 unit tests
15
cargo run # launch the designer
16
cargo build --release
17
```
18
19
**Linux:** add your user to the `dialout` group for USB-serial printer access.
20
21
## Releases (GitLab CI)
22
23
| Platform | Artifact | Install |
24
|----------|----------|---------|
25
| Linux | `.deb` (amd64) | `sudo dpkg -i posprint_*_amd64.deb` then `sudo apt-get install -f` |
26
| Windows | `posprint.exe` | Download from GitLab release job artifacts |
27
28
Tag a version (e.g. `v0.1.0`) to trigger release builds.
29
30
## Features
31
32
- Markdown-like template editor with live preview
33
- Page width: auto-scale or fixed width (mm)
34
- Save and load `.pos` files
35
- Parameter tokens (`${DocumentNumber}`) with print-time popup and value reuse
36
- Barcodes, QR codes, and images (including parameterized content)
37
- Print to USB-serial POS printers via raw ESC/POS bytes
38
- In-app **Help** tab (from [docs/HELP.md](docs/HELP.md))
39
40
## Dependencies (minimal)
41
42
| Crate | Why |
43
|-------|-----|
44
| `eframe` / `egui` | Native UI |
45
| `serde` / `serde_json` | `.pos` file format |
46
| `serialport` | USB-serial printer I/O |
47
| `image` | Load PNG/JPEG for `@image` |
48
| `rfd` | Native open/save dialogs |
49
50
ESC/POS encoding is implemented in-tree.
10
51
11
## Design documents
52
## Design documents
12
53
@@ -21,12 +62,7 @@ Pre-implementation — design phase. See [docs/](docs/) for specifications.21
62
22
## Planned features
63
## Planned features
23
64
24
- Markdown-like template editor with live preview
65
- Bluetooth printer support (deferred)
25
- Page width: auto-scale to window or fixed width (mm)
26
- Save and load `.pos` files
27
- Parameter tokens (`${DocumentNumber}`) with print-time popup and value reuse
28
- Barcodes, QR codes, and images (including parameterized content)
29
- Print to USB / Bluetooth POS printers via raw byte streams
30
66
31
## Quick feasibility summary
67
## Quick feasibility summary
32
68