summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJohannes Hofmann <Johannes.Hofmann@gmx.de>2026-10-26 20:05:20 +0100
committerJohannes Hofmann <Johannes.Hofmann@gmx.de>2026-10-26 20:05:20 +0100
commit375d87a9b0ec1cf2fffd705adb870c86144d2400 (patch)
tree1e8e05e7cd58686628d0f4622622456613a42e4d /README.md
parent45425dd047b791fe63f13a46a3251c529cfffc94 (diff)
Replace the C++ implementation with the Rust port
The Rust port (formerly gipfel-rs) is now the official successor to the FLTK/GSL C++ code base. This squashes the port into a single commit and removes the C++ sources (they remain in the git history below). Layout: crates/gipfel-core headless core: hills, panorama geometry, projections (maxima-generated derivatives), pure-Rust LM fit, gipfel: JPEG comment + EXIF I/O, profiles, stitching crates/gipfel-cli command-line tools (export, info, stitch, profiles) crates/gipfel-app Cosmic DE (libcosmic) GUI, binary name `gipfel` codegen/ maxima scripts + regen.sh for the projection code tests/ golden files + C++ reference harnesses (historical) The original README is kept for now; it will be updated to describe the Rust build. gipfel.dat, AUTHORS, ChangeLog and NEWS are unchanged.
Diffstat (limited to 'README.md')
-rw-r--r--README.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6099395
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+# gipfel-rs
+
+Rust port of [gipfel](https://git.flpsed.org/gipfel)'s computational core.
+
+- `crates/gipfel-core` — hills, panorama geometry, projections (maxima-generated
+ symbolic derivatives), pure-Rust Levenberg-Marquardt fit, `gipfel:` JPEG comment + EXIF I/O
+- `crates/gipfel-cli` — `export-position`, `export-hills`, `info`
+- `codegen/` — maxima scripts (`expr2rust.mac`) and `regen.sh`
+- `tests/` — C reference harnesses + golden files from the original C++ build
+
+```sh
+cargo test --lib --test golden # unit + golden tests
+cargo run -p gipfel-cli -- info <img.jpg>
+```
+
+The Rust build has no native C dependencies. Regenerate goldens with
+`tests/gen_golden.sh` (needs the built C++ tree, which uses GSL; see
+`GIPFEL_SRC`/`GIPFEL_DATA` in the script).
+
+## gipfel-app (M2/M3)
+
+COSMIC desktop application: `cargo build --release -p gipfel-app` →
+`target/release/gipfel [image.jpg] [--data gipfel.dat]`.
+
+- Viewport: ctrl+wheel zoom (cursor-anchored), wheel/drag pan, fit/zoom buttons
+- Left-drag a flag to reposition (refits on release); middle-click or
+ double-click toggles a hill "known"; right-click → Find Peak / Hide-Unhide
+- Viewpoint / Find Peak pickers are searchable dialogs
+- Sidebar: compass dial, focal/pitch/roll/visibility/track sliders, viewpoint
+ lat/lon/height, distortion k0/k1/x0, projection, show-hidden
+- File menu: Open/Save (writes the `gipfel:` comment), Screen Dump (PNG/JPG
+ with markers burned in), Load Track (CSV: lat,lon,height rows)
+- Install `crates/gipfel-app/data/org.gipfel.App.desktop` per freedesktop