mastodon-android Documentation

Official Android app for Mastodon

1,997 stars Java Java 1 file ยท ~1,405 tokens #android#mastodon
RAW Doc

Technical Documentation: mastodon/mastodon-android

โ„น๏ธ Provenance: Hybrid Fusion: mastodon/mastodon-android (README + 2 In-Tree Chapters) ยท CodeWiki Reference ยท Recency: Active (< 180 days)

1. Project Overview & Quickstart (mastodon/mastodon-android)

Mastodon for Android


You can also get the APK from the the Releases section.

Introduction

This is the repository for the official Android app for Mastodon.

Please note that this app is intended to be used with Mastodon servers. Our team does not have bandwidth to ensure compatibility with other server software, which means that unsolicited pull requests focused on that goal will most likely be closed.

Contributing

First, please read the Mastodon project Contributing guide.

Note that user interface changes for our official apps are carried out through a design process that involves core team review - most changes of this kind will not be accepted as community contributions; if they are accepted, they will take time to go through this review.

If you would like to help translate the app into your language, please go to Crowdin. If your language is not listed in the Crowdin project, please create an issue and we will add it. Please do not create pull requests that modify strings.xml files for languages other than English.

Building

As this app is using Java 17 features, you need JDK 17 or newer to build it. Other than that, everything is pretty standard. You can either import the project into Android Studio and build it from there, or run the following command in the project directory:

shell
./gradlew assembleRelease

License

This project is released under the GPL-3 License.

The Mastodon name and logo are trademarks. If you intend to redistribute a modified version of this app, use a unique name and icon for your app that does not mistakenly imply any official connection with or endorsement by the Mastodon non-profit organisation.

2. In-Tree Documentation Chapters (mastodon/mastodon-android)

File: README.md

Mastodon for Android


You can also get the APK from the the Releases section.

Introduction

This is the repository for the official Android app for Mastodon.

Please note that this app is intended to be used with Mastodon servers. Our team does not have bandwidth to ensure compatibility with other server software, which means that unsolicited pull requests focused on that goal will most likely be closed.

Contributing

First, please read the Mastodon project Contributing guide.

Note that user interface changes for our official apps are carried out through a design process that involves core team review - most changes of this kind will not be accepted as community contributions; if they are accepted, they will take time to go through this review.

If you would like to help translate the app into your language, please go to Crowdin. If your language is not listed in the Crowdin project, please create an issue and we will add it. Please do not create pull requests that modify strings.xml files for languages other than English.

Building

As this app is using Java 17 features, you need JDK 17 or newer to build it. Other than that, everything is pretty standard. You can either import the project into Android Studio and build it from there, or run the following command in the project directory:

shell
./gradlew assembleRelease

License

This project is released under the GPL-3 License.

The Mastodon name and logo are trademarks. If you intend to redistribute a modified version of this app, use a unique name and icon for your app that does not mistakenly imply any official connection with or endorsement by the Mastodon non-profit organisation.


File: fastlane/README.md

fastlane documentation

Installation

Make sure you have the latest version of the Xcode command line tools installed:

sh
xcode-select --install

For fastlane installation instructions, see Installing fastlane

Available Actions

Android

android test

sh
[bundle exec] fastlane android test

Runs all the tests

android deploy

sh
[bundle exec] fastlane android deploy

Deploy a new version to the Google Play


This README.md is auto-generated and will be re-generated every time fastlane is run.

More information about fastlane can be found on fastlane.tools.

The documentation of fastlane can be found on docs.fastlane.tools.

--- METRICS ---