From 95751fa79af943ca3e7d82297bfdb435f738ef40 Mon Sep 17 00:00:00 2001 From: casey langen Date: Sat, 17 Jun 2017 23:07:06 -0700 Subject: [PATCH] Update README.md --- src/musikdroid/README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/src/musikdroid/README.md b/src/musikdroid/README.md index 8fadead26..08f08fafc 100644 --- a/src/musikdroid/README.md +++ b/src/musikdroid/README.md @@ -2,13 +2,16 @@ `musikdroid` is an android app that is used to stream music from, or remote control, existing `musikbox` installations (windows, macos, or linux clients). +*disclaimer*: although `musikdroid` is generally very stable and performant, it does **not** employ best practices as prescribed by the android community at large. there is no `model-view-presenter`, and no `dependency injection`. it does not use architecture compoments (except for `Room`). it uses `RxJava`, but sparingly; only where it makes sense. instead, in general, it makes heavy use of lower-level android apis. + # building + because `musikdroid` is not available in the Google Play store, it currently uses [fabric.io](https://fabric.io) for crash reporting. this makes it slightly difficult to build out of the box, because the project's API keys are not checked in. if you are not a member of the dev team, but still want to play around with the code, you can do the following: 1. remove `Fabric.with(this, Crashlytics())` from `Application.kt` 2. remove `apply plugin: 'io.fabric'` from `app/build.gradle` -this should allow you to build and test locally without special keys. +this should allow you to build and test locally without special keys. in the future this will be simplified, and fabric will only be included in release build flavors. # attribution