Merge pull request #76 from tamirelazar/dev

Release v0.1.0: promote dev to master

Author: tamirelazar

.gitattributes

@@ -0,0 +1,4 @@
+# Golden reference files are compared byte-for-byte against generated output
+# that always uses LF. Force LF on checkout so Windows runners (core.autocrlf=true)
+# don't rewrite them to CRLF and break the snapshot tests.
+tests/golden/** text eol=lf

.github/workflows/ci.yml

@@ -2,8 +2,11 @@ name: CI
 
 on:
   workflow_dispatch:
+  # Push CI runs only on master (post-merge verification). Work on dev and
+  # feature branches is covered by its pull request, so pushing to dev while a
+  # PR is open no longer double-triggers the suite.
   push:
-    branches: [master, dev]
+    branches: [master]
     paths-ignore:
       - '**.md'
       - 'LICENSE'
@@ -102,6 +105,14 @@ jobs:
     - name: Run cargo test
       run: cargo test --verbose
 
+    # Gated feature code (multi-species, audio, gui) is not compiled by the
+    # default build; run lib tests with all features so refactors cannot
+    # silently break it. Linux only: deps are installed above and the full
+    # GUI stack is too expensive to build on the paid runners.
+    - name: Run cargo test (all features, lib)
+      if: runner.os == 'Linux'
+      run: cargo test --all-features --lib
+
   licenses:
     name: License Check
     needs: hygiene

CHANGELOG.md

@@ -1,72 +1,41 @@
 # Changelog
 
-All notable changes to tslime are documented in this file.
+All notable changes to this project will be documented in this file.
+Format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/);
+versioning follows [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+## [0.1.0] - TBD
 
-## [Unreleased]
+First public release.
 
 ### Added
-- Comprehensive README with installation and usage documentation
-- Man page documentation (docs/tslime.1.md)
-- Contributing guide (CONTRIBUTING.md)
-- Screenshots directory with example outputs
-- Demo tape file for GIF generation
-- 8 new presets: minimal, moss, cosmic, fire, zen, storm, river, ethereal
-- 4 new color palettes: legiblemono, moss, cosmic, ethereal
-- Custom palette support via hex color strings
-- WebM video export with FFmpeg
-- Mouse interaction modes (attract/repel)
-- Terrain effects (smooth, turbulent, mixed)
-- Wind simulation
-- Species mode with multiple agent types
-- Obstacle support (circle, rect, image-based)
-- Motion blur / trail history
-- Adaptive brightness normalization
-- Dithering modes (ordered, error diffusion)
-- Grid overlay options
-- Runtime parameter adjustment via keyboard
-- Undo/redo for parameter changes
-- Config save/load functionality
-- Comprehensive parameter validation with bounds checking
+- Physarum simulation (Jones 2010 model) with 31 presets and runtime parameter controls
+- `trademark` preset (alias `logo`) — the tslime logo held as a stable figure (constellation re-stamp behavior with the embedded logo image as the template); bound to quick-key `4` by default
+- Terminal rendering: half-block, ASCII, braille, quadrant, shade, points, and sculpted charsets; 22 OKLch-based color palettes
+- Screensaver and interactive modes; pause, restart, preset/palette cycling at runtime
+- GIF, PNG, and WebM export
+- Window-frame display modes
+- README hero demo: a looping montage that grows the tslime logo across the
+  Organic, Constellation, Vinescii, and Trademark launch presets
+- README gallery: six looping demos of the runtime controls — palette cycling,
+  character sets, preset transitions, randomize, live parameter tuning, and the
+  palette editor (replaces the earlier static preset stills)
+- No-notifications mode: suppress transient toasts and ambient parameter
+  readouts for a clean field. Start with `--no-notifications`; toggle live with
+  `Ctrl+N`. User-opened overlays (controls, palette editor, dashboard, preset
+  transitions) are unaffected.
+- `vinescii` preset — the vines (flocking) pattern in pure ASCII
+- Experimental: multi-species, choir audio, and GUI (feature-gated); WASM build (standalone crate)
 
 ### Changed
-- Updated noise crate from 0.2 to 0.9 (fixes future Rust compatibility)
-- Improved error handling throughout codebase
-- Enhanced CLI validation with helpful error messages
-
-### Fixed
-- Clippy warnings (manual_range_contains, manual_find)
-- Duplicate build targets for memory benchmarks
-- Unsafe unwrap() calls in WebM export and frame capture
-- Future-incompatibility warnings from deprecated num-* crates
-- Duplicate code blocks in `trail_map.rs` and `timing.rs`
-
-### Documentation
-- Completed API documentation for all public modules (100% coverage)
-- Updated README with all 16 palettes and 12 presets
-- Added module-level documentation
-- Fixed intra-doc links in library documentation
-
-## [0.1.0] - 2024-12-24
-
-### Added
-- Initial release
-- Physarum simulation based on Jeff Jones particle model
-- Four presets: network, exploratory, tendrils, organic
-- Four color palettes: organic, heat, ocean, mono
-- Multiple character modes: half-block, ASCII, braille
-- Screensaver, live, and print modes
-- Configurable simulation parameters
-- 256-color ANSI rendering with half-block characters
-- Visual regression tests
-- CI/CD pipeline with GitHub Actions
-- Cross-platform support (Linux, macOS, Windows)
-
-### Technical
-- Rust implementation with zero runtime dependencies
-- crossterm for cross-platform terminal handling
-- clap for CLI argument parsing
-- rand_xoshiro for fast, seedable PRNG
-- Optimized for low CPU and memory usage
+- Quick-keys `1`–`4` now switch the launch presets (Organic, Constellation, Vinescii, Trademark).
+- Preset pass: renamed pulse→slime, flocking→vines, ripple→smoke, lumen→mold
+  (old names still accepted as CLI aliases); per-preset visual tuning applied
+  (braille/quadrant charsets, palette assignments, auto-normalize, window frames);
+  constellation re-rolls its init layout on reset and auto-resets on collapse.
+- Fixed the stale `--preset` help text (was listing removed presets).
+
+### Added (Custom Keybinds)
+- Custom key bindings via `~/.config/tslime/keybinds.toml`: bind keys `1`–`7` to any preset or
+  saved config; user binds override the defaults. A/B compare (`Shift+1`–`7`) works for bound
+  presets and configs. The `?` overlay shows live bindings.