@@ -6,17 +6,20 @@ The user-facing command is `yzs`
66
77``` bash
88nix run github:luccahuguet/yazelix-screen#yzs
9+ nix run github:luccahuguet/yazelix-screen#yzs -- static
910nix run github:luccahuguet/yazelix-screen#yzs -- mandelbrot
1011nix run github:luccahuguet/yazelix-screen#yzs -- game_of_life_bloom --cell-style dotted
12+ nix run github:luccahuguet/yazelix-screen#yzs -- random --duration-seconds 3
1113```
1214
1315## What It Contains
1416
1517- Animation engines for Boids, Mandelbrot, and Game of Life
18+ - Static and logo-style Yazelix welcome screens
1619- File-backed Kitty PNG frame sequence rendering
1720- Frame production through ` ScreenFrameProducer `
1821- Terminal sizing helpers and alternate-screen rendering helpers
19- - A standalone ` yzs ` binary
22+ - A standalone ` yzs ` binary with interactive and timed playback
2023- Small examples for library consumers
2124
2225## User Command
@@ -26,8 +29,10 @@ Installed standalone command:
2629``` bash
2730yzs --help
2831yzs
32+ yzs static
2933yzs mandelbrot
3034yzs game_of_life_bloom --cell-style dotted
35+ yzs random --duration-seconds 3
3136```
3237
3338Yazelix users get the integrated screen surface through the main command:
@@ -43,20 +48,26 @@ From this repository:
4348
4449``` bash
4550cargo run --bin yzs -- --help
51+ cargo run --bin yzs -- static
4652cargo run --bin yzs -- mandelbrot
4753cargo run --bin yzs -- game_of_life_bloom --cell-style dotted
54+ cargo run --bin yzs -- random --duration-seconds 3
4855```
4956
5057With Nix:
5158
5259``` bash
5360nix build .# yzs
5461nix run .# yzs -- --help
62+ nix run .# yzs -- static
5563nix run .# yzs -- mandelbrot
64+ nix run .# yzs -- random --duration-seconds 3
5665```
5766
5867Supported styles:
5968
69+ - ` static `
70+ - ` logo `
6071- ` boids `
6172- ` boids_predator `
6273- ` boids_schools `
@@ -88,7 +99,7 @@ The second argument is the frame count. The examples use only `yazelix_screen` A
8899
89100## Boundary With Yazelix
90101
91- ` yazelix_screen ` owns reusable animation and terminal-rendering primitives. Yazelix product behavior stays outside the crate
102+ ` yazelix_screen ` owns reusable animation and terminal-rendering primitives, including standalone Yazelix-branded screen styles. Integrated welcome/session policy stays outside the crate
92103
93104The crate must not depend on:
94105
@@ -123,7 +134,7 @@ v0.1.0
123134From this repository:
124135
125136``` bash
126- cargo fmt --check
137+ cargo fmt --all -- -- check
127138cargo check --examples
128139cargo test
129140cargo run --bin yzs -- --help
0 commit comments