From 7b658abd46513c0d78ef483ce4874b00ce3548ce Mon Sep 17 00:00:00 2001 From: pyr0ball Date: Mon, 1 Jun 2026 11:05:32 -0700 Subject: [PATCH] feat: add initial README --- README.md | 99 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 99 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..f6f89bb --- /dev/null +++ b/README.md @@ -0,0 +1,99 @@ +
+ +# Nightjar + +**Local-first mycology assistant. Cultivation tracking, strain and species library, fruiting journal — no cloud required.** + +[![Status](https://img.shields.io/badge/status-backlog-lightgrey)](https://git.opensourcesolarpunk.com/Circuit-Forge/nightjar) +[![License](https://img.shields.io/badge/license-BSL%201.1-blue)](LICENSE) +[![CircuitForge](https://img.shields.io/badge/CircuitForge-LLC-green)](https://circuitforge.tech) + +[Website](https://circuitforge.tech) · [Roadmap](https://git.opensourcesolarpunk.com/Circuit-Forge/roadmap) · [All Products](https://circuitforge.tech/#products) + +
+ +--- + +> *Part of the [Circuit Forge LLC](https://circuitforge.tech) menagerie — AI for the tasks the system made hard on purpose.* + +**Status:** Backlog — not yet started. See the [roadmap](https://git.opensourcesolarpunk.com/Circuit-Forge/roadmap) for priority order. + +## What it does + +Nightjar tracks your mushroom cultivation from spawn to harvest: batch logging, fruiting condition records, strain genealogy, species identification from photos, and LLM-assisted troubleshooting when a flush goes sideways. + +The European nightjar (Caprimulgus europaeus) hunts entirely in the dark, navigating by sound and shadow to find what others miss. Fungi grow in the dark too — in substrate, in logs, in the hidden mycelial network that precedes every flush. Nightjar is the tool that helps you pay attention to what is happening in there. + +## Why it is hard + +Mycology cultivation fails from poor record-keeping: + +- Contamination sources are invisible until they bloom; without logs, patterns do not emerge +- Strain genealogy degrades when clones are passed between growers without documentation +- Fruiting conditions (temperature, humidity, CO2, light cycle) interact in ways that require historical data to tune +- Field identification is high-stakes: the difference between edible and toxic species is not always visually obvious to newer foragers + +## Core pipeline + +``` +Register strain or species (name, source, substrate, inoculation date) + → Log environmental conditions (temp, humidity, CO2 level) + → Record milestones (colonization, pinning, flush dates) + → Photo log each flush → Human confirms harvest + → LLM-assisted troubleshooting (describe symptoms or upload photo) + → Build multi-batch history and yield statistics + → Field foraging mode: photo ID with confidence score and safety notes +``` + +## Feature areas + +- **Strain registry**: species, variety, source, inoculation substrate, generation tracking for clones +- **Batch log**: timeline from inoculation to harvest; yield weight per flush +- **Condition tracker**: temperature, relative humidity, CO2 ppm, fresh air exchange schedule +- **Fruiting journal**: photo log with timestamps; pin counts; flush notes +- **Troubleshooting**: photo upload or symptom description; visual model suggests contamination type, deficiency, or environmental cause +- **Field ID mode**: identify foraged specimens from photos with confidence score and explicit safety warnings +- **Offline-first**: all data stays local; no account required for core use + +## Privacy · Safety · Accessibility + +**Privacy:** All cultivation records and photos stay on your device. Cloud sync (Paid tier) is opt-in and end-to-end encrypted. + +**Safety:** Field identification is a starting point only, never a final answer. Every ID result includes explicit safety warnings. Nightjar will never present a field identification as confirmed edibility. When in doubt, the app says so in plain language. + +**Accessibility:** Latin binomials always paired with common names. Photo capture supports multiple input modes. Interface designed for low-light viewing (you are often checking logs in a grow tent). + +## Tiers + +| Tier | What you get | +|------|-------------| +| **Free** | Strain registry, batch log, condition tracker, fruiting journal, local LLM troubleshooting | +| **Paid** | Cloud sync and photo backup, community strain library, enhanced field ID model | +| **Premium** | Fine-tuned visual model for your specific substrate and conditions, multi-site grow room support | + +## Get involved + +Nightjar is pre-development. The best thing you can do right now is open an issue with: + +- Your cultivation setup (agar work, bulk grows, monotubs, logs, outdoor beds, etc.) +- Data you currently track in spreadsheets or paper logs that you wish was easier +- Field foraging workflows you want supported +- Safety features you think are essential before this ships + +Early issues shape what gets built first. Star the repo to follow progress. + +## Product code + +License key format: `CFG-NTJR-XXXX-XXXX-XXXX` + +## Tech notes + +- Built on the shared [circuitforge-core](https://git.opensourcesolarpunk.com/Circuit-Forge/circuitforge-core) scaffold +- Visual model: local vision LLM for contamination diagnosis and field specimen identification +- Species database: integration with MycoPortal and iNaturalist taxonomy +- Data format: SQLite local store, JSON export for portability +- Sensor integration (Paid): optional read from temperature and humidity sensors via local API + +## License + +[Business Source License 1.1](LICENSE) — free for personal non-commercial self-hosting. Converts to MIT after four years. Commercial use requires a [paid license](https://circuitforge.tech/pricing).