Skip to content

Add release information section on README #340

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 15, 2025
Merged

Add release information section on README #340

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
73edf56
Fix points to how to compile documents
samuelbles07 Sep 15, 2025
e984ace
Add release process
samuelbles07 Sep 15, 2025
8985e08
fix link typo
samuelbles07 Sep 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,23 @@ Make sure you have exactly the versions of libraries and boards installed as des

If you have an older version of the AirGradient PCB not mentioned in the example files, please downgrade this library to version 2.4.15 to support these legacy boards.

### Release Process

Releases published on GitHub are **not immediately deployed to all devices in the market**. Each release first goes through internal testing, including limited deployments in select locations to verify stability and functionality.

If the tests pass, the firmware is then made available for:
- **FOTA (Firmware Over-The-Air) updates** from AirGradient dashboard
- **Manual flashing** via [Airgradient](https://www.airgradient.com/documentation/firmwares/) website

Each GitHub release note will also include the planned rollout date for wider availability.

## Help & Support

If you have any questions or problems, check out [our forum](https://forum.airgradient.com/).

## Development

* See [compilation instructions](/docs/local-server.md) for details about how to customize AirGradient's firmware and flash it to your device.
* See [compilation instructions](/docs/howto-compile.md) for details about how to customize AirGradient's firmware and flash it to your device.

## Over the air (OTA) updates

Expand Down