update fastlane and docs

This commit is contained in:
Kieran BW 2021-06-11 20:32:57 +01:00
parent cb4ac000bc
commit 8353f08beb
10 changed files with 184 additions and 0 deletions

12
CHANGELOG.md Normal file
View File

@ -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

22
LICENSE.md Normal file
View File

@ -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.

139
README.md Normal file
View File

@ -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)
<!-- omit in toc -->
# Android.WhooSticker
<img src="readme-assets/icons/name.png" alt="Project Icon" width="750">
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 <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
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)
<!--
### Get it on Google Play
1. Open the Google Play app
2. Search for Brainf
**Or**
[<img src="readme-assets/badges/google-play-download.png"
alt="Get it on Google Play" height="80">](https://play.google.com/store/apps/)
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 /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**
[<img src="readme-assets/badges/direct-apk-download.png" alt="Direct apk
download" height="80">](/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
<https://help.github.com/en/articles/cloning-a-repository>
#### 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
<https://help.github.com/en/desktop/contributing-to-projects/cloning-a-repository-from-github-to-github-desktop>
### 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 | |
|:-: |:-: |
|<img src="metadata/en-US/images/phoneScreenshots/screenshot-1.png" alt="Screenshot 1" width="300">|<img src="metadata/en-US/images/phoneScreenshots/screenshot-2.png" alt="Screenshot 2" width="300">|
|<img src="metadata/en-US/images/phoneScreenshots/screenshot-3.png" alt="Screenshot 3" width="300">|<img src="metadata/en-US/images/phoneScreenshots/screenshot-4.png" alt="Screenshot 4" width="300">|
|<img src="metadata/en-US/images/phoneScreenshots/screenshot-5.png" alt="Screenshot 5" width="300">|<img src="metadata/en-US/images/phoneScreenshots/screenshot-6.png" alt="Screenshot 6" width="300">|

View File

@ -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

View File

@ -0,0 +1 @@
Sticker-board for android inspired by uSticker (forked from woosticker).

1
metadata/en-US/title.txt Normal file
View File

@ -0,0 +1 @@
WhooSticker

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.4 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 14 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.4 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 11 KiB