Skip to content
Switch branches/tags


Failed to load latest commit information.


Prepare Zephyr Release

Welcome to Zephyr

Welcome! Most documentation is hosted over at the Zephyr Documentation Site, but this README is here to give you a quick tour of what's what.

What is Zephyr?

Zephyr, and it's sister-project Aire, are projects designed to help you quickly and easily build, test, and release modular applications.

Modular Applications 101

If you've ever used GIMP, Adobe Photoshop, or Wordpress, then you've used an extensible application, which is very similar to a modular application. In fact, for many applications, extensible and modular may be used interchangeably.

Extensible applications are applications that can be extended by users, other vendors, or the application vendor themselves. As a user, you frequently interact with extensions as plugins--for instance, you may need a filter or format from your image-processing program that isn't provided by the vendor, so you locate the plugin you'd like to install from the list of plugins on their website or in their application and


Submitting a Pull Request

Submitting a pull request will automatically trigger a build, as well as kick off PR linting.

To get the PR linting phase to pass, there are a few requirements:

  1. PR is assigned to the author (happens automatically with the github-actions bot)
  2. Body of PR includes the issue the PR is resolving. This should be the canonical link (e.g. #83)
  3. PR is added to Zephyr Development Board (should happen automatically, but may be outstanding issues with workflow)

A reviewer should also be assigned, but this is not required to get the linting to pass.

Build Instructions

  1. Install Maven
  2. Install Gradle
  3. Create a file under $HOME/.gradle/
  4. In $HOME/.gradle/ add the following lines:
  5. Run mvn clean install -f bom
  6. Run gradle