diff --git a/README.md b/README.md index d56950e23..adc3b09f0 100644 --- a/README.md +++ b/README.md @@ -1,62 +1,85 @@ - - - -[Project Intro](https://codeberg.org/comaps#comaps) - | [Governance](https://codeberg.org/comaps/Governance#comaps-project-governance-docs) - | [FAQ](https://codeberg.org/comaps/Governance/src/branch/main/FAQ.md) - | [Contribute](#contributing) - | [Donate](https://www.comaps.app/donate) - | [Keep Connected](https://codeberg.org/comaps#keep-connected) - -# [CoMaps](https://comaps.app) – Hike, Bike, Drive Offline – Easy Map Navigation with Privacy - -[ - ![GitHub Actions Workflow Android Status](https://img.shields.io/github/actions/workflow/status/comaps/comaps/.github%2Fworkflows%2Fandroid-check.yaml?style=flat&label=Android%20Build&logo=android&logoColor=white) -](https://github.com/comaps/comaps/actions/workflows/android-check.yaml) -[ - ![GitHub Actions Workflow iOS Status](https://img.shields.io/github/actions/workflow/status/comaps/comaps/.github%2Fworkflows%2Fios-check.yaml?style=flat&label=iOS%20Build&logo=apple&logoColor=white) -](https://github.com/comaps/comaps/actions/workflows/ios-check.yaml) -[ - ![Donate via OpenCollective](https://img.shields.io/opencollective/all/comaps?logo=opencollective&color=blue&label=Open%20Collective%20Donors) -](https://opencollective.com/comaps) -[ - ![Donate via Liberapay](https://img.shields.io/liberapay/patrons/CoMaps.svg?logo=liberapay&label=Liberapay%20Patrons&color=efcc00&) -](https://liberapay.com/CoMaps) + +

+ Project Intro | + Governance | + FAQ | + Contribute | + Donate | + Keep Connected +

-A community-led free & open source maps app based on [OpenStreetMap](https://www.openstreetmap.org) data and reinforced with commitment to transparency, privacy and being not-for-profit. CoMaps is a fork/spin-off of Organic Maps, which in turn is a fork of Maps.ME. +
+

CoMaps

+

Hike, Bike, Drive Offline - Easy Map Navigation with Privacy

+
+
+

+ + License + + + Android Build Status + + + iOS Build Status + + + Open Collective Donors + + + Liberapay Patrons + +

+
-There are apps for Android and iOS (and ARM MacOS). -An alpha Linux / MacOS Qt desktop version, which is also suitable for Linux phones. +--- -[App Store](https://apps.apple.com/app/comaps/id6747180809) -[Google Play](https://play.google.com/store/apps/details?id=app.comaps.google) -[F-Droid](https://f-droid.org/en/packages/app.comaps.fdroid/) -[Codeberg](https://codeberg.org/comaps/comaps/releases) +A community-led free & open source maps app based on [OpenStreetMap](https://www.openstreetmap.org), built for transparency, privacy, and not-for-profit values. A fork of Organic Maps, originally based on Maps.ME. -

+**Available for:** Android, iOS, ARM macOS, and alpha Linux/macOS desktop builds (also usable on Linux phones). + +

+ + App Store + + + Google Play + + + F-Droid + + + Codeberg + +

+ + + +

+ +

-**Offline-focused**: Plan and navigate your trip abroad without the need for cellular service, search waypoints while on a distant hike, etc. All app functions are designed to work offline. +--- -**Respecting Privacy**: The app is designed with privacy in mind - does not identify people, does not track, and does not collect personal information. Ads-free. +## ⚡️ Highlights -**Simple and Polished**: Essential, easy to use features that just work. +- **Offline-first**: Navigate without a connection +- **Privacy-respecting**: No tracking, Ads or data collection +- **Lightweight**: Battery- and space-efficient +- **Simple**: Polished, user-focused interface +- **Community-built**: Free, open source, and collaborative +- **Transparent**: Open finances and governance -**Saves Your Battery and Space**: Doesn’t drain your battery like other navigation apps. Compact maps save precious space on your phone. +--- -**Free and Built by the Community**: People like you helped build the app by adding places to [OpenStreetMap](https://www.openstreetmap.org), testing and giving feedback on features and contributing their development skills and money. - -**Open and Transparent Decision-making and Financials, Not-for-profit and Fully Open Source.** - -### Main Features +## 🚀 Main Features - Downloadable detailed maps with places which are not available with Google Maps @@ -86,41 +109,46 @@ An alpha Linux / MacOS Qt desktop version, which is also suitable for Linux phon - Android Auto and CarPlay support -*Freedom Is Here - Discover your journey, navigate the world with privacy and community at the forefront!* + ***Freedom Is Here – Navigate the world with privacy and community at the forefront.*** -## Contributing +--- + +## 🤝 Contributing You can help by donating, contributing code, translating, or by telling others about it. To build the best maps app there is a need for software development, design, product, community development, and other areas. Reach out to us and let us know how you want to help. -If you want to build the project, check [docs/INSTALL.md](docs/INSTALL.md). If you want to help the project, -see [docs/CONTRIBUTING.md](docs/CONTRIBUTING.md). You can help in many ways, the ability to code is not necessary. +- Build instructions: [docs/INSTALL.md](docs/INSTALL.md) +- Contribution guide: [docs/CONTRIBUTING.md](docs/CONTRIBUTING.md) +> [!NOTE] +> Some docs might be outdated, contain broken links or old references to Organic Maps, etc. Its a work in progress and help is much appreciated! -Some docs might be outdated, contain broken links or old references to Organic Maps, etc. Its a work in progress and help is much appreciated! +There is a dedicated Zulip chat for active contributors: [Zulip](https://comaps.zulipchat.com) -There is a dedicated Zulip chat for active contributors: [comaps.zulipchat.com](https://comaps.zulipchat.com) +--- -### Feedback +## 💬 Feedback +- Rate us on [App Store](https://apps.apple.com/app/comaps/id6747180809) and [Google Play](https://play.google.com/store/apps/details?id=app.comaps.google) +- Star our repos on Codeberg +- Report bugs or request features on the [issue tracker](https://codeberg.org/comaps/comaps/issues) -- **Rate us on the [App Store](https://apps.apple.com/app/comaps/id6747180809) -and [Google Play](https://play.google.com/store/apps/details?id=app.comaps.google)**. -- Star our repos on Codeberg -- Report bugs and discuss features at [the issue tracker](https://codeberg.org/comaps/comaps/issues) +--- -## How is development funded? - -The app is free for everyone, so we rely on donations. Please [donate](https://opencollective.com/comaps/donate) to support the CoMaps community and see this open project thrive! +## 💸 Funding +CoMaps is free. To stay that way, it relies on your support. +Donate via [OpenCollective](https://opencollective.com/comaps/donate) or [Liberapay](https://liberapay.com/CoMaps). The project's financial information is completely open and transparent at [our Open Collective](https://opencollective.com/comaps). -## Privacy +--- -The Android application was analysed by the [Exodus platform](https://reports.exodus-privacy.eu.org/fr/reports/app.comaps.google/latest/) +## 🔒 Privacy -## License and Copyright +The Android app has been reviewed by [Exodus Privacy](https://reports.exodus-privacy.eu.org/fr/reports/app.comaps.google/latest/). -Licensed under the Apache License, Version 2.0. See -[LICENSE](LICENSE), -[NOTICE](NOTICE) -and [data/copyright.html](data/copyright.html) -for more information. +--- + +## ⚖️ License + +Licensed under the Apache License 2.0. +See [LICENSE](LICENSE), [NOTICE](NOTICE), and [data/copyright.html](data/copyright.html). \ No newline at end of file diff --git a/docs/badges/apple-appstore.png b/docs/badges/apple-appstore.png index 31351fa58..c09547289 100644 Binary files a/docs/badges/apple-appstore.png and b/docs/badges/apple-appstore.png differ diff --git a/docs/badges/codeberg.png b/docs/badges/codeberg.png index 6c0eb643b..a29b3b217 100644 Binary files a/docs/badges/codeberg.png and b/docs/badges/codeberg.png differ diff --git a/docs/badges/fdroid.png b/docs/badges/fdroid.png index c1fc8492a..e8034c541 100644 Binary files a/docs/badges/fdroid.png and b/docs/badges/fdroid.png differ diff --git a/docs/badges/google-play.png b/docs/badges/google-play.png index fa9499136..6f857ade4 100644 Binary files a/docs/badges/google-play.png and b/docs/badges/google-play.png differ