Files
sfhorizont/docs/README.md
T
2026-10-24 13:20:55 +02:00

45 lines
2.3 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# Horizon survey app — design handoff
A cross-platform phone app that makes **artificial horizon files** for astrophotography software:
- **NINA custom horizon (`.hrz`)**: the primary output. Most users (and the author) image with NINA.
- **Stellarium landscape**: a 360° panorama with transparent sky (spherical), or a horizon outline only (polygonal), for other users.
The user stands where the telescope stands and turns once around with the phone. The app shoots a band of photos around the horizon automatically, detects sky vs. obstruction, lets the user fix the mask, then exports.
Design canvas (interactive, same account): https://claude.ai/code/artifact/b39ed0ec-bcdd-4582-9cf6-2d98f4ec0d56
## Read in this order
1. `SPEC.md`: screens, behaviour, states and copy, screen by screen (with PNGs).
2. `ARCHITECTURE.md`: WebAssembly core, platform adapters, core API, recorded session format, algorithms.
3. `FORMATS.md`: exact output formats, checked against the Stellarium source and NINA docs.
4. `design/tokens.json`: colors, type, radii, spacing.
5. `examples/`: generated sample outputs and a sample recorded session.
## Contents
```
README.md
SPEC.md
ARCHITECTURE.md
FORMATS.md
design/
tokens.json
screens/*.png rendered screens, 390x844 @2x
source/*.dc.html design source per screen (see design/source/README.md)
source/README.md
examples/
nina/backyard-pier.hrz
stellarium-spherical/ landscape.ini, horizon.txt, panorama placeholder note
stellarium-polygonal/ landscape.ini, horizon.txt
session/ session.json + sensors.jsonl (recorded capture bundle format)
```
## Notes for the implementing agent
- The design files are **reference, not production code**. Rebuild the UI in the project's own UI stack and match the PNGs and tokens.
- All sample data is illustrative: coordinates, the horizon profile and frame counts. `[APP NAME]`, `[AUTHOR]`, `[LAT]`, `[LON]` and `[ELEV]` are placeholders.
- Accuracy goal: about ±2–3° in azimuth, absorbed by a user-set safety margin (default +2°). Star or landmark alignment was explored and **dropped as unnecessary**. North comes from compass + declination, plus a manual north offset in Review.
- Keep the core free of I/O so it runs identically in a desktop browser (development, replaying recorded sessions) and on the phone.