mirror of
https://github.com/quik-sms/quik.git
synced 2026-11-17 11:38:51 +01:00
691ac19a9e
* Add DeepWiki badge Updated README to include DeepWiki badge for auto-updating deepwiki docs * docs(contributing): give DeepWiki its own section with badge The link was buried at the end of "Getting Your Pull Request Merged", a section about PR etiquette rather than reading code. Move it under its own heading at the top of Helpful Tips, where someone about to explore the codebase will actually look, and add the badge to match the README. --------- Co-authored-by: octoshrimpy <git@octo.sh>
94 lines
5.2 KiB
Markdown
94 lines
5.2 KiB
Markdown

|
|
|
|
# QUIK
|
|
|
|
[](https://github.com/octoshrimpy/quik/actions/workflows/manual-release.yml)
|
|
<a href="https://hosted.weblate.org/engage/quik/"><img src="https://hosted.weblate.org/widget/quik/svg-badge.svg" alt="Translation status" /></a>
|
|
[](https://deepwiki.com/octoshrimpy/quik)
|
|
|
|
QUIK is an open source replacement to the [stock messaging app](https://github.com/android/platform_packages_apps_mms) on Android. It is a continuation of [QKSMS](https://github.com/moezbhatti/qksms).
|
|
|
|
## Features
|
|
|
|
- Scheduled messages
|
|
- Message backup
|
|
- Speech-to-text and text-to-speech integrated within the app
|
|
- Message blocking and archiving
|
|
- Voice messages
|
|
- Attachments of any type of file
|
|
- Message sorting
|
|
- Message pinning
|
|
- Delayed sending
|
|
- Quick reply from notifications
|
|
- Swipe actions
|
|
- Emoji reaction handling
|
|
- and much, much more
|
|
|
|
## Download
|
|
|
|
Grab QUIK from the official [github releases page](https://github.com/octoshrimpy/quik/releases), or keep up with updates with the following:
|
|
|
|
|
|
<a href="https://f-droid.org/repository/browse/?fdid=dev.octoshrimpy.quik.fdroid"><img src="https://f-droid.org/badge/get-it-on.png" alt="Get it on F-Droid" height="100"></a>
|
|
<a href="https://apps.obtainium.imranr.dev/redirect?r=obtainium://app/{%22id%22:%22dev.octoshrimpy.quik%22,%22url%22:%22https://github.com/octoshrimpy/quik%22,%22author%22:%22octoshrimpy%22,%22name%22:%22QUIK%22,%22additionalSettings%22:%22{\%22apkFilterRegEx\%22:\%22release\%22,\%22invertAPKFilter\%22:false,\%22about\%22:\%22QUIK%20is%20an%20open%20source%20replacement%20for%20the%20stock%20messaging%20app%20on%20Android.%20It%20is%20a%20continuation%20of%20QKSMS.\%22}%22}"><img src="https://raw.githubusercontent.com/ImranR98/Obtainium/b1c8ac6f2ab08497189721a788a5763e28ff64cd/assets/graphics/badge_obtainium.png" alt="Get it on Obtainium" height="100"></a>
|
|
<a href="https://github.com/octoshrimpy/quik/releases">
|
|
<img src="https://user-images.githubusercontent.com/69304392/148696068-0cfea65d-b18f-4685-82b5-329a330b1c0d.png"
|
|
alt="Download from GitHub releases" height="100" /></a>
|
|
<!--
|
|
</a><a href="https://play.google.com/store/apps/details?id=dev.octoshrimpy.quik"><img src="https://play.google.com/intl/en_us/badges/images/generic/en_badge_web_generic.png" alt="Download on Google Play" height="100">
|
|
-->
|
|
|
|
## Matrix Chat
|
|
You can chat with the community over at [#quik-sms:matrix.org](https://matrix.to/#/#quik-sms:matrix.org)
|
|
|
|
## Reporting bugs
|
|
|
|
A great bug report contains a description of the problem and steps to reproduce the problem. We need to know what we're looking for and where to look for it.
|
|
|
|
When reporting a bug, please make sure to provide the following information:
|
|
- Steps to reproduce the issue
|
|
- QUIK version
|
|
- Device / OS information
|
|
|
|
## Contributing
|
|
Contributions are very welcome! Please see the [contributing guidelines](/CONTRIBUTING.md) for details.
|
|
|
|
## Translations
|
|
If you'd like to add translations to QUIK, please join the project on [Weblate](https://hosted.weblate.org/engage/quik/)! Translations that are committed directly to source files will not be accepted. For more information see the [translation guidelines](/CONTRIBUTING.md#translate).
|
|
|
|
<a href="https://hosted.weblate.org/engage/quik/">
|
|
<img src="https://hosted.weblate.org/widget/quik/multi-auto.svg" alt="Translation status" />
|
|
</a>
|
|
|
|
## Thank you
|
|
|
|
A special thank you to Jake ([@klinker41](https://github.com/klinker41)) and Luke Klinker ([@klinker24](https://github.com/klinker24)) for their work on [android-smsmms](https://github.com/klinker41/android-smsmms), which has been an unspeakably large help in implementing MMS into QUIK.
|
|
|
|
A giant thank you to Moez [moezbhatti](https://github.com/moezbhatti) for creating and maintaining QKSMS, of which QUIK would not exist without.
|
|
|
|
## Contact
|
|
|
|
QUIK is developed and maintained by [Marcos Jones](https://github.com/octoshrimpy).
|
|
|
|
---
|
|
|
|
## Star History
|
|
|
|
<a href="https://star-history.com/#octoshrimpy/quik&Date">
|
|
<picture>
|
|
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=octoshrimpy/quik&type=Date&theme=dark" />
|
|
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=octoshrimpy/quik&type=Date" />
|
|
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=octoshrimpy/quik&type=Date" />
|
|
</picture>
|
|
</a>
|
|
|
|
---
|
|
|
|
<!-- <a href="https://liberapay.com/octoshrimpy/donate"><img alt="Donate using Liberapay" src="https://img.shields.io/badge/Liberapay-F6C915?style=for-the-badge&logo=liberapay&logoColor=black"></a> -->
|
|
<a style="background-color: #5e40c2;" href="https://ko-fi.com/octoshrimpy/donate"><img alt="Donate using Ko-Fi" src="https://img.shields.io/badge/Ko--fi-F16061?style=for-the-badge&logo=ko-fi&logoColor=white"></a>
|
|
<a href="https://patreon.com/octoshrimpy"><img alt="Donate using Patreon" src="https://img.shields.io/badge/Patreon-F96854?style=for-the-badge&logo=patreon&logoColor=white"></a>
|
|
|
|
## License
|
|
|
|
QUIK is released under the **The GNU General Public License v3.0 (GPLv3)**, which can be found in the [LICENSE](LICENSE) file in the root of this project.
|