mirror/musikcube
1
0
Fork 0
mirror of https://github.com/clangen/musikcube.git synced 2024-11-19 20:13:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
casey langen 2017-06-17 23:07:06 -07:00 committed by GitHub
parent 0ed9a1114a
commit 95751fa79a
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
src/musikdroid/README.md
View File

@ -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