ContextQMD
Back to Breezy Weather

README

README.md

6.2.012.5 KB
Original Source
<div align="center"> </div> <h1 align="center">Breezy Weather</h1> <div align="center"> <a href="https://kotlinlang.org/"> </a> <a href="https://developer.android.com/compose"> </a> <a href="https://m3.material.io/"> </a> <a href="https://github.com/breezy-weather/breezy-weather/blob/main/LICENSE"> </a> <a href="https://github.com/breezy-weather/breezy-weather/releases"> </a> <a href="https://apt.izzysoft.de/fdroid/index/apk/org.breezyweather/"> </a> <a href="https://f-droid.org/packages/org.breezyweather/"> </a> </div> <h4 align="center">Breezy Weather is a feature-rich free and open source Material 3 Expressive weather app with well-though-out visualizations, supporting forecast, observations, nowcasting, air quality, pollen, alerts, from more than 50 weather sources.</h4> <div align="center">

⬇️ Download

<a href="https://github.com/breezy-weather/breezy-weather/releases"> </a> <a href="https://github.com/breezy-weather/breezy-weather/blob/main/INSTALL.md#obtainium"> </a> <a href="https://github.com/breezy-weather/breezy-weather/blob/main/INSTALL.md#f-droid-client"> </a> </div> <div align="center"> <p><a href="https://github.com/breezy-weather/breezy-weather/blob/main/INSTALL.md"><strong>All installation methods</strong></a></p> </div> <div align="center"> <p><strong>SHA-256 hash of the signing certificate:</strong> 29d435f70aa9aec3c1faff7f7ffa6e15785088d87f06ecfcab9c3cc62dc269d8

SHA-256 checksums are also provided per file on the <a href="https://github.com/breezy-weather/breezy-weather/releases">GitHub releases page</a>.</p>

</div> <hr /> <div align="center"> </div>

✨ Features

  • 🌤️ Weather data

    • Daily and hourly forecasts up to 16 days
    • Precipitation in the next hour
    • Severe weather and precipitation alerts
    • Temperature / Feels like temperature / Normals
    • Precipitation
    • Wind
    • Air quality
    • Pollen & Mold
    • Humidity
    • UV index
    • Visibility
    • Pressure
    • Sun
    • Moon

  • 📊 Visualization

    • Detailed 24-hour charts
    • Material 3 Expressive blocks

  • 🏭 More than 50 weather sources supported (<a href="docs/SOURCES.md">full list</a>)

  • 🧩 Large selection of widgets

  • 🖼️ Live wallpaper

  • 📦 Custom icon packs

  • 🌙 Automatic dark mode

  • 🔁 Opt-in data sharing with other apps (such as Gadgetbridge)

  • <details><summary>🚹 Accessibility</summary>
    • Localization
      • Number formatting (different numeral systems, decimal separator, thousand separator)
      • Unit formatting
      • Alternate calendar
    • Readability
      • Good content descriptions for screen readers
      • Navigation with screen readers: most things should work, features depending on drag & drop not yet supported
      • Custom display settings: basic support
</details>
  • <details><summary>🆓 Free and Open Source</summary>
    • No proprietary blobs/dependencies
    • Releases generated by GitHub actions, guaranteeing it matches the source code
    • Fully works with Open-Meteo (FOSS source)
    • Separate flavor with only sources hosted on FOSS networks
</details>
  • <details><summary>🛡️ Privacy-friendly</summary>
    • No personal data collected by the app (link to app privacy policy)
    • Multiple sources are available, with links to their privacy policies for transparency
    • Current location is optional and not added by default
    • If using current location, an IP location service can be used instead of GPS to send less accurate coordinates to weather source
    • No trackers/automatic crash reporters
</details>

🛟 Help

🤝 Contribute

Pull requests are welcome. You can have a look at issues opened to contributions. For other changes, please open an issue first to discuss what you would like to change.

Features currently being worked on by a contributor

  • Announcement - Make Breezy weather data available through a ContentProvider. Landed in v6.1.0. Currently in an experimental phase; feedback appreciated
  • #10 - “Add location” page needs a new design, in the spirit of Google Maps where you can select location points on the map, or search manually - No mockup done yet

Features lacking an active contributor

  • #937 - Widget overhaul (prerequisite for any new widget improvement) - Some mockups were done but no one is working on it anymore

Features that will not be implemented

  • Paid-only sources, too limited free-tier, or free-tier that requires privacy-invasive information (credit card info, phone number, etc)
  • Radar; please check out this document for alternatives
  • Adding standard flavor or non-free sources to the F-Droid default repo: please use the standard flavor from a different store/source instead
  • Changes to the background updates process, including but not limited: options for refreshing less than every 30 minutes, every time you open the app, every time you tap on widget, every time you unlock your phone
  • “Circular sky” interface: you can set a fixed light/dark background globally from Main screen settings instead.
  • Publish to Google Play Store: please check alternatives
  • Allow different flavors to be installed in parallel
  • Implement features that are no longer available in latest Android versions
  • Backport features/fixes from latest Android versions to older Android versions
  • Donations: if you have extra money to spare, consider donating to Open-Meteo to support infrastructure costs and future developments (we currently lack a libre and gratis worldwide alternative for the following features: Reverse geocoding, Alerts, Normals)

🌍 Translations

Translation is done externally on Weblate. Please read carefully project instructions if you want to help.

English (and regional variants) and French translations are maintained by repo maintainers, but they are open to proofreading/improvements. You will need to make a pull request, as we didn’t find a way to make these languages in suggestion-only mode in Weblate (let us know if you find anything).

For unit formatting, we use Unicode data as much as possible. If you believe there is an error, please open a discussion with evidences that the changes you suggest is the recommendation for your language.

✉️ Contact us

  • If you’d like to report a bug or suggest a new feature, GitHub discussions or issues are best for organization.
  • We’ve also created a Matrix/Element space with a number of different channels for more general discussion: #breezy-weather-space:matrix.org.
    • If you are not comfortable writing a GitHub discussion/issue in English, you can ask on the channel if someone can help you in your language.
    • If you’d prefer a direct channel link instead of a space link, here’s the main Breezy Weather Matrix channel: #breezy-weather:matrix.org

📜 License

  • GNU Lesser General Public License v3.0
  • This License does not grant any rights in the trademarks, service marks, or logos of any Contributor.
  • Misrepresentation of the origin of that material is prohibited, and modified versions of such material must be marked in reasonable ways as different from the original version.

Before creating a fork, check if the intent action nodomain.freeyourgadget.gadgetbridge.ACTION_GENERIC_WEATHER can cover your need (for example, you want to re-use our weather data in your own customized widget). It can be enabled from Settings > Widgets & Live Wallpaper > Data sharing. You can also help testing our ContentProvider exposing the full weather data of Breezy Weather.

Otherwise, remember to:

  • Respect the project’s LICENSE
  • Avoid confusion with the Breezy Weather app: