https://github.com/sbrl/pepperminty-wiki-client-android

:wrench: WIP :wrench: An experimental Pepperminty Wiki client, written in Kotlin for Android.
https://github.com/sbrl/pepperminty-wiki-client-android

android client experimental kotlin pepperminty-wiki wiki-viewer wip

Last synced: about 2 months ago
JSON representation

:wrench: WIP :wrench: An experimental Pepperminty Wiki client, written in Kotlin for Android.

• Host: GitHub
• URL: https://github.com/sbrl/pepperminty-wiki-client-android
• Owner: sbrl
• License: mpl-2.0
• Created: 2018-03-25T15:51:09.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2023-02-18T18:09:54.000Z (almost 2 years ago)
• Last Synced: 2024-10-10T22:32:31.524Z (2 months ago)
• Topics: android, client, experimental, kotlin, pepperminty-wiki, wiki-viewer, wip
• Language: Kotlin
• Size: 1.11 MB
• Stars: 4
• Watchers: 4
• Forks: 0
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Changelog: Changelog.md
  • Funding: FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# Pepperminty-Wiki-Client-Android

> :wrench: WIP :wrench: An experimental [Pepperminty Wiki](https://github.com/sbrl/Pepperminty-Wiki) client, written in Kotlin for Android.

**Latest Version:** v0.2 (internal testing) v0.3-dev (development) ([Changelog](https://github.com/sbrl/Pepperminty-Wiki-Client-Android/blob/master/Changelog.md))

## Install

### Method 1: Build from Source

1. Install _Android Studio_

2. Clone this repository

3. Make sure that _USB Debugging_ is enabled in your phone

4. Connect your phone to your computer

5. Hit the "Run" button in _Android Studio_

6. Disconnect your phone, optionally disabling _USB Debugging_.

### Method 2: From the Google Play Store

This app is available for beta testing in the Google Play Store!

Link: [Pepperminty Wiki Client](https://play.google.com/store/apps/details?id=com.sbrl.peppermint)

Be sure to leave a good review :P

Any issues should be reported here as an issue. I am exponentially more likely to respond on here than to a review in the Google Play store.

## Notes

Google Play policies are wildly complicated. Notes here are to remind me about various things.

 - Use the `EmojiCompat` class for all user-supplied strings to ensure the newest emojis are always supported

## Contributions

Contributions are welcome! Simply send open a pull request :smiley_cat:

## License

The Pepperminty Wiki Android Client is released under the Mozilla Public License 2.0. The full license text is included in the LICENSE file in this repository.