|
|
TBC |
|
|
\ No newline at end of file |
|
|
## Development environment
|
|
|
|
|
|
In order to contribute to Funkwhale For Android you should install Google's Android Studio. As you probably have noticed, the project's source code is managed in a Git repository on a Gitlab instance hosted by the Funkwhale project.
|
|
|
|
|
|
## Getting the source code
|
|
|
|
|
|
In the Gitlab project for Funkwhale For Android, go to Repository->Files and look for the "Clone" button. Copy one of the urls (Git or HTTPS) and use your git to clone it to your local setup.
|
|
|
|
|
|
## Building Funkwhale For Android
|
|
|
|
|
|
In order to build the app you will need JDK8. Android Studio comes packaged with one, should you want to build the app on a command line, you can easily install it using [SdkMan!](https://sdkman.io/) (see below). The project is built using Gradle, but you don't need to install Gradle manually, as we are using Gradle Wrapper. Once you've cloned the repository, go to your command line and enter `./gradlew.sh`.
|
|
|
|
|
|
## SdkMan
|
|
|
|
|
|
The project comes with an SdkMan! environment that you can activate, in order to use a suitable JDK, should you want to build the app on a terminal. This makes it easier if you use different JDK versions for other projects. You can setup SdkMan! to automatically load and unload environments, more information can be found [here](https://sdkman.io/usage) and [here](https://reinhard.codes/2021/06/18/automatic-switching-of-java-sdk-versions/).
|
|
|
|
|
|
## Towncrier
|
|
|
|
|
|
We are using [Towncrier](https://pypi.org/project/towncrier/) to manage change logs. Towncrier is a Python tool and it only works with Python 3. Please consult the Towncrier project page for installation instructions.
|
|
|
|
|
|
> TODO: Add towncrier example workflow here |
|
|
\ No newline at end of file |