diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..2cc113a --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,12 @@ +# Changelog +All major and minor version changes will be documented in this file. Details of +patch-level version changes can be found in [commit messages](../../commits/master). + +## first release - 2021/06/11 +- Add to gh +- todo... + - compile apks + - create changelog + - screenshots + - app logo + - stick on fdroid + google play diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..cdff474 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,22 @@ +MIT License + +Copyright (c) 2021 Kieran W +Copyright (c) 2021 Randy Zhou (rzhou1999) + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..8f05a4a --- /dev/null +++ b/README.md @@ -0,0 +1,139 @@ +[![GitHub top language](https://img.shields.io/github/languages/top/FredHappyface/Android.WhooSticker.svg?style=for-the-badge)](../../) +[![Repository size](https://img.shields.io/github/repo-size/FredHappyface/Android.WhooSticker.svg?style=for-the-badge)](../../) +[![Issues](https://img.shields.io/github/issues/FredHappyface/Android.WhooSticker.svg?style=for-the-badge)](../../issues) +[![License](https://img.shields.io/github/license/FredHappyface/Android.WhooSticker.svg?style=for-the-badge)](/LICENSE.md) +[![Commit activity](https://img.shields.io/github/commit-activity/m/FredHappyface/Android.WhooSticker.svg?style=for-the-badge)](../../commits/master) +[![Last commit](https://img.shields.io/github/last-commit/FredHappyface/Android.WhooSticker.svg?style=for-the-badge)](../../commits/master) + + +# Android.WhooSticker + +Project Icon + +Sticker-board for android inspired by uSticker (forked from woosticker). + + +- [Features](#features) +- [Language Information](#language-information) + - [Kotlin and Android Version](#kotlin-and-android-version) + - [Download Android Studio](#download-android-studio) +- [How to Run](#how-to-run) + - [Build From Source](#build-from-source) + - [Download the APK](#download-the-apk) +- [Changelog](#changelog) +- [Download](#download) + - [Clone](#clone) + - [Using The Command Line](#using-the-command-line) + - [Using GitHub Desktop](#using-github-desktop) + - [Download Zip File](#download-zip-file) +- [Licence](#licence) +- [Screenshots](#screenshots) + - [Mobile](#mobile) + +## Features + +- Add a directory containing stickers + - Supported formats include .png, .gif, .jpg, .apng ,.webp +- Select the keyboard +- Send stickers in supported apps (.png is used as a fallback) +- Ties in with the system theme + +## Language Information + +### Kotlin and Android Version +This app has been written in Kotlin 1.5.0 with the Android Studio IDE. +- The target SDK version is 30 (Android 11) +- The minimum SDK version is 28 (Android 9 Pie) + + +#### Download Android Studio +Download the Android Studio IDE from . +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 + + +## How to Run +### Build From Source +1. Download or clone this GitHub repository +2. (If downloaded) Extract the zip archive +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) + + + + + +### Download the APK +1. For releases, navigate to the /app/release directory. For debug, navigate to /app/debug +2. Select the debug or release APK depending on your preference. Note that the +filenames are in the form: app-(debug/release)_(version)_yyyy-mm-dd.apk (I would recommend +downloading the most recent release APK) + +**Or** + +[Direct apk +download](/app/release) + +Follow the link to the /app/release directory by clicking on the badge above, then +select the preferred version. + + +## Changelog +See the [CHANGELOG](/CHANGELOG.md) for more information. + +## Download +### Clone +#### Using The Command Line +1. Press the Clone or download button in the top right +2. Copy the URL (link) +3. Open the command line and change directory to where you wish to +clone to +4. Type 'git clone' followed by URL in step 2 +```bash +$ git clone https://github.com/FredHappyface/Android.WhooSticker +``` + +More information can be found at + + +#### Using GitHub Desktop +1. Press the Clone or download button in the top right +2. Click open in desktop +3. Choose the path for where you want and click Clone + +More information can be found at + + +### Download Zip File + +1. Download this GitHub repository +2. Extract the zip archive +3. Copy/ move to the desired location + + +## Licence +MIT License +Copyright (c) FredHappyface +Copyright (c) Randy Zhou +(See the [LICENSE](/LICENSE.md) for more information.) + + +## Screenshots + +### Mobile +|Screenshots | | +|:-: |:-: | +|Screenshot 1|Screenshot 2| +|Screenshot 3|Screenshot 4| +|Screenshot 5|Screenshot 6| diff --git a/metadata/en-US/full_description.txt b/metadata/en-US/full_description.txt new file mode 100644 index 0000000..c24407b --- /dev/null +++ b/metadata/en-US/full_description.txt @@ -0,0 +1,9 @@ +Sticker-board for android inspired by uSticker (forked from woosticker). + +## Features + +- Add a directory containing stickers + - Supported formats include .png, .gif, .jpg, .apng ,.webp +- Select the keyboard +- Send stickers in supported apps (.png is used as a fallback) +- Ties in with the system theme \ No newline at end of file diff --git a/metadata/en-US/short_description.txt b/metadata/en-US/short_description.txt new file mode 100644 index 0000000..f43626f --- /dev/null +++ b/metadata/en-US/short_description.txt @@ -0,0 +1 @@ +Sticker-board for android inspired by uSticker (forked from woosticker). diff --git a/metadata/en-US/title.txt b/metadata/en-US/title.txt new file mode 100644 index 0000000..967c97f --- /dev/null +++ b/metadata/en-US/title.txt @@ -0,0 +1 @@ +WhooSticker \ No newline at end of file diff --git a/readme-assets/badges/amazon-appstore-download.png b/readme-assets/badges/amazon-appstore-download.png new file mode 100644 index 0000000..449c0ab Binary files /dev/null and b/readme-assets/badges/amazon-appstore-download.png differ diff --git a/readme-assets/badges/apkpure-download.png b/readme-assets/badges/apkpure-download.png new file mode 100644 index 0000000..deeaf6c Binary files /dev/null and b/readme-assets/badges/apkpure-download.png differ diff --git a/readme-assets/badges/direct-apk-download.png b/readme-assets/badges/direct-apk-download.png new file mode 100644 index 0000000..5d00901 Binary files /dev/null and b/readme-assets/badges/direct-apk-download.png differ diff --git a/readme-assets/badges/google-play-download.png b/readme-assets/badges/google-play-download.png new file mode 100644 index 0000000..922238a Binary files /dev/null and b/readme-assets/badges/google-play-download.png differ