Development

Run these from the repository root.

make venv              # set up Python for the server
make plates            # download the illustrations
make plates-all        # download all 435 of Audubon's illustrations (about 2.9 GB)
make preview           # render a sample Northern Cardinal to test_output/
make preview-all       # render every species with an illustration
make preview-collage   # render a daily collage
make preview-fallback  # render a name card
make preview-ee02      # render the Cardinal for the EE02 color kit
make serve             # run the server on port 8181
make test              # run the tests

make plates downloads only the illustrations Featherframe uses, from every book. Both can run again safely, and retry failed downloads.

make preview runs the whole rendering process without hardware or detections. Run it after any change to how pictures are rendered, and check test_output/.

Warning

Start any test server on your home network with FEATHERFRAME_NO_MDNS=1. Otherwise, a frame that can't reach its own server may connect to yours.

AGENTS.md describes the architecture in detail.