update project readme
This commit is contained in:
Kieran W
parent
ba2cc953b2
commit
4a5ac2fc03
170
README.md
170
README.md
@ -1,5 +1,7 @@
|
|||||||
|
|
||||||
|
<img src="metadata/en-US/images/featureGraphic.png" alt="Feature Graphic" width="">
|
||||||
|
|
||||||
[](../../)
|
[](../../)
|
||||||
[](../../)
|
|
||||||
[](../../issues)
|
[](../../issues)
|
||||||
[](/LICENSE.md)
|
[](/LICENSE.md)
|
||||||
[](../../commits/master)
|
[](../../commits/master)
|
||||||
@ -9,27 +11,20 @@
|
|||||||
<!-- omit in toc -->
|
<!-- omit in toc -->
|
||||||
# Android.EweSticker
|
# Android.EweSticker
|
||||||
|
|
||||||
<img src="metadata/en-US/images/featureGraphic.png" alt="Feature Graphic" width="750">
|
EweSticker is an Android sticker keyboard application, specifically designed for sharing a wide variety of custom stickers in supported messaging apps. This project draws inspiration from the uSticker project and is a fork of the woosticker repository.
|
||||||
|
|
||||||
Sticker-board for android inspired by uSticker (forked from woosticker).
|
|
||||||
|
|
||||||
- [Features](#features)
|
- [Features](#features)
|
||||||
- [Screenshots](#screenshots)
|
- [Screenshots](#screenshots)
|
||||||
- [Documentation](#documentation)
|
- [Documentation](#documentation)
|
||||||
|
- [Installation](#installation)
|
||||||
- [Gradle tasks](#gradle-tasks)
|
- [Gradle tasks](#gradle-tasks)
|
||||||
- [Language Information](#language-information)
|
- [Kotlin and Android Version](#kotlin-and-android-version)
|
||||||
- [Kotlin and Android Version](#kotlin-and-android-version)
|
- [Building From Source](#building-from-source)
|
||||||
- [Download Android Studio](#download-android-studio)
|
- [Git Clone](#git-clone)
|
||||||
- [How to Run](#how-to-run)
|
|
||||||
- [Build From Source](#build-from-source)
|
|
||||||
- [Get it on F-Droid](#get-it-on-f-droid)
|
|
||||||
- [Get it on Google Play](#get-it-on-google-play)
|
|
||||||
- [Download the APK](#download-the-apk)
|
|
||||||
- [Download Project](#download-project)
|
|
||||||
- [Clone](#clone)
|
|
||||||
- [Using The Command Line](#using-the-command-line)
|
- [Using The Command Line](#using-the-command-line)
|
||||||
- [Using GitHub Desktop](#using-github-desktop)
|
- [Using GitHub Desktop](#using-github-desktop)
|
||||||
- [Download Zip File](#download-zip-file)
|
- [(or) Download Zip File](#or-download-zip-file)
|
||||||
|
- [Download Android Studio](#download-android-studio)
|
||||||
- [Community Files](#community-files)
|
- [Community Files](#community-files)
|
||||||
- [Licence](#licence)
|
- [Licence](#licence)
|
||||||
- [Changelog](#changelog)
|
- [Changelog](#changelog)
|
||||||
@ -37,25 +32,25 @@ Sticker-board for android inspired by uSticker (forked from woosticker).
|
|||||||
- [Contributing](#contributing)
|
- [Contributing](#contributing)
|
||||||
- [Security](#security)
|
- [Security](#security)
|
||||||
- [Support](#support)
|
- [Support](#support)
|
||||||
- [Rationale](#rationale)
|
- [Development Info](#development-info)
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
- Wide range of custom stickers supported
|
The EweSticker Android app offers the following key features to enhance your messaging experience:
|
||||||
- image/gif
|
|
||||||
- image/png
|
- **Wide Range of Custom Stickers Supported**: EweSticker supports a diverse set of sticker formats, ensuring that users can share their creativity in various ways. Supported formats include image/gif, image/png, image/webp, image/jpeg, image/heif, video/3gpp, video/mp4, video/x-matroska, and video/webm.
|
||||||
- image/webp
|
|
||||||
- image/jpeg
|
- **Seamless Sticker Sharing**: Users can easily send stickers within messaging apps that support custom media sharing using image/png as a fallback.
|
||||||
- image/heif
|
|
||||||
- video/3gpp
|
- **Customizable Scrolling**: The app offers both vertical and horizontal scrolling options, enabling users to navigate through their sticker collection according to their preferred orientation.
|
||||||
- video/mp4
|
|
||||||
- video/x-matroska
|
- **Sticker Preview Customization**: Users have the freedom to adjust the number of rows and the sticker preview size, tailoring the viewing experience to their liking and device screen dimensions.
|
||||||
- video/webm
|
|
||||||
- Send stickers in supported apps (image/png is used as a fallback)
|
- **Integration with System Theme**: EweSticker seamlessly integrates with the system's theme, ensuring that the app's appearance aligns with the user's device-wide design choices.
|
||||||
- Vertical and Horizontal scrolling
|
|
||||||
- Change number of rows and sticker preview size
|
- **Sticker Preview on Long Press**: To facilitate sticker selection, users can long-press on a sticker to reveal a preview. This feature helps users quickly decide which sticker they want to share without the need to open the sticker collection separately.
|
||||||
- Ties in with the system theme
|
|
||||||
- Long press on a sticker to show a preview
|
EweSticker brings a wide range of customization options, diverse format support, and integration with messaging apps. Whether users are sharing static images, animated GIFs, or even short videos, the app aims to provide an engaging and expressive way to communicate using custom stickers.
|
||||||
|
|
||||||
## Screenshots
|
## Screenshots
|
||||||
|
|
||||||
@ -81,79 +76,40 @@ where to look for certain things:
|
|||||||
- The [Help](/documentation/help) guide provides a starting point and outlines common issues that you
|
- The [Help](/documentation/help) guide provides a starting point and outlines common issues that you
|
||||||
may have.
|
may have.
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
You can install the app using the following methods, Follow the link to the listing on your
|
||||||
|
preferred store by clicking on one of the badges below, then download/install:
|
||||||
|
|
||||||
|
[<img src="readme-assets/badges/f-droid-download.png" alt="Get it on F-Droid" height="80">](https://f-droid.org/en/packages/com.fredhappyface.ewesticker/)
|
||||||
|
[<img src="readme-assets/badges/google-play-download.png" alt="Get it on Google Play" height="80">](https://play.google.com/store/apps/details?id=com.fredhappyface.ewesticker)
|
||||||
|
[<img src="readme-assets/badges/direct-apk-download.png" alt="Direct apk download" height="80">](../../releases)
|
||||||
|
|
||||||
|
<!-- omit in toc -->
|
||||||
|
### Build from Source
|
||||||
|
|
||||||
|
Follow the steps in [Building from Source](link_to_building_from_source) section.
|
||||||
|
|
||||||
## Gradle tasks
|
## Gradle tasks
|
||||||
|
|
||||||
- ktlintCheck (`gradlew ktlintCheck`): run ktlint over the codebase
|
- ktlintCheck (`gradlew ktlintCheck`): run ktlint over the codebase
|
||||||
- genDocs (`gradlew genDocs`): generate the api reference using dokka
|
- genDocs (`gradlew genDocs`): generate the api reference using dokka
|
||||||
|
|
||||||
## Language Information
|
## Kotlin and Android Version
|
||||||
|
|
||||||
### Kotlin and Android Version
|
This app has been written in Kotlin 1.9.0 with the Android Studio IDE.
|
||||||
|
|
||||||
This app has been written in Kotlin 1.5.0 with the Android Studio IDE.
|
- The target SDK version is 33 (Android 13)
|
||||||
|
|
||||||
- The target SDK version is 31 (Android 12)
|
|
||||||
- The minimum SDK version is 26 (Android 8 Oreo)
|
- The minimum SDK version is 26 (Android 8 Oreo)
|
||||||
|
|
||||||
#### Download Android Studio
|
## Building From Source
|
||||||
|
|
||||||
Download the Android Studio IDE from <https://developer.android.com/studio/>.
|
|
||||||
For Windows, double click the downloaded .exe file and follow the instructions
|
|
||||||
provided by the installer - it will download the Android emulator and the
|
|
||||||
Android SDK. Additional information can be found at
|
|
||||||
<https://developer.android.com/studio/install>
|
|
||||||
|
|
||||||
## How to Run
|
|
||||||
|
|
||||||
### Build From Source
|
|
||||||
|
|
||||||
1. Download or clone this GitHub repository
|
1. Download or clone this GitHub repository
|
||||||
2. (If downloaded) Extract the zip archive
|
2. (If downloaded) Extract the zip archive
|
||||||
3. In Android Studio click File > Open and then navigate to the project file
|
3. In Android Studio click File > Open and then navigate to the project file
|
||||||
(Android studio defaults to the directory of the last opened file)
|
(Android studio defaults to the directory of the last opened file)
|
||||||
|
|
||||||
### Get it on F-Droid
|
### Git Clone
|
||||||
|
|
||||||
1. Open the F-Droid app
|
|
||||||
2. Search for EweSticker
|
|
||||||
|
|
||||||
or
|
|
||||||
|
|
||||||
[<img src="readme-assets/badges/f-droid-download.png"
|
|
||||||
alt="Get it on F-Droid" height="80">](https://f-droid.org/en/packages/com.fredhappyface.ewesticker/)
|
|
||||||
|
|
||||||
Follow the link to the listing on F-Droid by clicking on the badge above,
|
|
||||||
then download/ install
|
|
||||||
|
|
||||||
### Get it on Google Play
|
|
||||||
|
|
||||||
1. Open the Google Play app
|
|
||||||
2. Search for EweSticker
|
|
||||||
|
|
||||||
or
|
|
||||||
|
|
||||||
[<img src="readme-assets/badges/google-play-download.png"
|
|
||||||
alt="Get it on Google Play" height="80">](https://play.google.com/store/apps/details?id=com.fredhappyface.ewesticker)
|
|
||||||
|
|
||||||
Follow the link to the listing on Google Play by clicking on the badge above,
|
|
||||||
then download/ install
|
|
||||||
|
|
||||||
### Download the APK
|
|
||||||
|
|
||||||
1. For releases, navigate to the releases page [here](../../releases).
|
|
||||||
2. Select the debug or release APK depending on your preference. Note that the
|
|
||||||
filenames are in the form: com.fredhappyface.ewesticker-(version)-(debug|release).apk
|
|
||||||
|
|
||||||
or
|
|
||||||
|
|
||||||
[<img src="readme-assets/badges/direct-apk-download.png" alt="Direct apk
|
|
||||||
download" height="80">](../../releases)
|
|
||||||
|
|
||||||
Navigate to the releases page by clicking on the badge above.
|
|
||||||
|
|
||||||
## Download Project
|
|
||||||
|
|
||||||
### Clone
|
|
||||||
|
|
||||||
#### Using The Command Line
|
#### Using The Command Line
|
||||||
|
|
||||||
@ -179,12 +135,20 @@ https://help.github.com/en/articles/cloning-a-repository
|
|||||||
More information can be found at
|
More information can be found at
|
||||||
https://help.github.com/en/desktop/contributing-to-projects/cloning-a-repository-from-github-to-github-desktop
|
https://help.github.com/en/desktop/contributing-to-projects/cloning-a-repository-from-github-to-github-desktop
|
||||||
|
|
||||||
### Download Zip File
|
### (or) Download Zip File
|
||||||
|
|
||||||
1. Download this GitHub repository
|
1. Download this GitHub repository
|
||||||
2. Extract the zip archive
|
2. Extract the zip archive
|
||||||
3. Copy/ move to the desired location
|
3. Copy/ move to the desired location
|
||||||
|
|
||||||
|
### Download Android Studio
|
||||||
|
|
||||||
|
Download the Android Studio IDE from <https://developer.android.com/studio/>.
|
||||||
|
For Windows, double click the downloaded .exe file and follow the instructions
|
||||||
|
provided by the installer - it will download the Android emulator and the
|
||||||
|
Android SDK. Additional information can be found at
|
||||||
|
<https://developer.android.com/studio/install>
|
||||||
|
|
||||||
## Community Files
|
## Community Files
|
||||||
|
|
||||||
### Licence
|
### Licence
|
||||||
@ -198,35 +162,33 @@ See the [Changelog](/CHANGELOG.md) for more information.
|
|||||||
|
|
||||||
### Code of Conduct
|
### Code of Conduct
|
||||||
|
|
||||||
Online communities include people from many backgrounds. The *Project*
|
Our project welcomes individuals from diverse backgrounds and perspectives.
|
||||||
contributors are committed to providing a friendly, safe and welcoming
|
We are committed to providing a friendly, safe and welcoming environment for all. Please see the
|
||||||
environment for all. Please see the
|
|
||||||
[Code of Conduct](https://github.com/FredHappyface/.github/blob/master/CODE_OF_CONDUCT.md)
|
[Code of Conduct](https://github.com/FredHappyface/.github/blob/master/CODE_OF_CONDUCT.md)
|
||||||
for more information.
|
for more information.
|
||||||
|
|
||||||
### Contributing
|
### Contributing
|
||||||
|
|
||||||
Contributions are welcome, please see the
|
Your contributions are valuable and help improve the project for everyone, please see the
|
||||||
[Contributing Guidelines](https://github.com/FredHappyface/.github/blob/master/CONTRIBUTING.md)
|
[Contributing Guidelines](https://github.com/FredHappyface/.github/blob/master/CONTRIBUTING.md)
|
||||||
for more information.
|
for more information.
|
||||||
|
|
||||||
### Security
|
### Security
|
||||||
|
|
||||||
Thank you for improving the security of the project, please see the
|
If you discover a security vulnerability, we appreciate your responsible disclosure. Please see the
|
||||||
[Security Policy](https://github.com/FredHappyface/.github/blob/master/SECURITY.md)
|
[Security Policy](https://github.com/FredHappyface/.github/blob/master/.github/SECURITY/SECURITY.md)
|
||||||
for more information.
|
for more information.
|
||||||
|
|
||||||
### Support
|
### Support
|
||||||
|
|
||||||
Thank you for using this project, I hope it is of use to you. Please be aware that
|
Thank you for using this project, I hope it is of use to you. Please keep in mind that
|
||||||
those involved with the project often do so for fun along with other commitments
|
the folks working on this project are enthusiasts with various commitments such as work,
|
||||||
(such as work, family, etc). Please see the
|
family, and other passions. See the
|
||||||
[Support Policy](https://github.com/FredHappyface/.github/blob/master/SUPPORT.md)
|
[Support Policy](https://github.com/FredHappyface/.github/blob/master/SUPPORT.md)
|
||||||
for more information.
|
for more information.
|
||||||
|
|
||||||
### Rationale
|
### Development Info
|
||||||
|
|
||||||
The rationale acts as a guide to various processes regarding projects such as
|
Serves as a guide to various aspects of project development, including versioning, style guidelines, and recommended practices. Please see the
|
||||||
the versioning scheme and the programming styles used. Please see the
|
[Rationale](https://github.com/FredHappyface/.github/blob/master/DEVELOPMENT_INFO.md)
|
||||||
[Rationale](https://github.com/FredHappyface/.github/blob/master/RATIONALE.md)
|
|
||||||
for more information.
|
for more information.
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user