From e8b1ba63e836ec31bbf7fab7048ca810984bf9b5 Mon Sep 17 00:00:00 2001
From: Philipp Heckel <pheckel@datto.com>
Date: Wed, 24 Nov 2021 23:16:48 -0500
Subject: [PATCH] Build instructions
---
README.md | 25 +++++++++++++++++++------
build.gradle | 2 +-
2 files changed, 20 insertions(+), 7 deletions(-)
diff --git a/README.md b/README.md
index 9f2af7d..7cb5527 100644
--- a/README.md
+++ b/README.md
@@ -3,17 +3,30 @@ This is the Android app for [ntfy](https://github.com/binwiederhier/ntfy) ([ntfy
in the [Play Store](https://play.google.com/store/apps/details?id=io.heckel.ntfy).
# Releases
-You can find the app in the [Play Store](https://play.google.com/store/apps/details?id=io.heckel.ntfy), or as .apk files on the [releases page](https://github.com/binwiederhier/ntfy-android/releases).
+You can find the app in the [Play Store](https://play.google.com/store/apps/details?id=io.heckel.ntfy),
+or as .apk files on the [releases page](https://github.com/binwiederhier/ntfy-android/releases).
-There is a ticket to create an [F-Droid version](https://github.com/binwiederhier/ntfy/issues/7), but I haven't had the time yet.
+There is a ticket to create an [F-Droid version](https://github.com/binwiederhier/ntfy/issues/7),
+but I haven't had the time yet.
-# Build instructions
-(Todo)
+# Build
-## Building with your own Firebase Cloud Messaging (FCM) account
+## Building without Firebase (F-Droid flavor)
+Without Firebase, you may want to still change the default `app_base_url` in [strings.xml](https://github.com/binwiederhier/ntfy-android/blob/main/app/src/main/res/values/strings.xml)
+if you're self-hosting the server. Then run:
+```
+./gradlew assembleFdroidRelease
+```
+
+## Building with Firebase (FCM, Google Play flavor)
To build your own version with Firebase, you must:
-* Put your own `google-services.json` file in the [app/ folder](https://github.com/binwiederhier/ntfy-android/tree/main/app)
+* Create a Firebase/FCM account
+* Place your account file at `app/google-services.json`
* And change `app_base_url` in [strings.xml](https://github.com/binwiederhier/ntfy-android/blob/main/app/src/main/res/values/strings.xml)
+* Then run:
+```
+./gradlew assemblePlayRelease
+```
## License
Made with ❤️ by [Philipp C. Heckel](https://heckel.io), distributed under the [Apache License 2.0](LICENSE).
diff --git a/build.gradle b/build.gradle
index 642b6ef..5e9e565 100644
--- a/build.gradle
+++ b/build.gradle
@@ -7,7 +7,7 @@ buildscript {
dependencies {
classpath 'com.android.tools.build:gradle:4.1.0'
classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
- classpath 'com.google.gms:google-services:4.3.10'
+ classpath 'com.google.gms:google-services:4.3.10' // This is removed in the "fdroid" flavor
// NOTE: Do not place your application dependencies here; they belong
// in the individual module build.gradle files