From 5a76865362e72571fb272f72945c3d9b49dbd490 Mon Sep 17 00:00:00 2001
From: Janne Koschinski <janne@kuschku.de>
Date: Sun, 31 Jan 2016 05:04:36 +0100
Subject: [PATCH] Added README, adjusted library names for easier readme
---
README.md | 83 ++++++++++++++++++++++++++++++++++++++++++++++++
app/build.gradle | 4 +--
2 files changed, 85 insertions(+), 2 deletions(-)
create mode 100644 README.md
diff --git a/README.md b/README.md
new file mode 100644
index 000000000..d53ab4358
--- /dev/null
+++ b/README.md
@@ -0,0 +1,83 @@
+# QuasselDroid-ng
+
+Quassel is a distributed, decentralized IRC client, written using C++ and Qt.
+QuasselDroid is a pure-java client for the Quassel core, allowing you to connect
+to your Quassel core using your Android ™ phone.
+
+##Build Requirements
+
+QuasselDroid requires you to have the latest version of gradle installed, and
+a recent version of the Android SDK installed (and configures via sdk.dir in
+local.properties)
+
+Additionally, it requires you to build (in the same way) first the following
+libraries:
+
+* https://github.com/justjanne/AndroidSlidingUpPanel
+* https://github.com/justjanne/aspm
+
+The libraries of each have to be placed in `app/libs/` for gradle to find them.
+
+QuasselDroid uses the following libraries (although these are automatically
+downloaded from maven central):
+
+* [**libquassel-java**](https://github.com/justjanne/libquassel-java) LGPL 3.0
+* [**Guava**](https://github.com/google/guava) Apache 2.0
+* [**Joda-Time**](https://github.com/JodaOrg/joda-time/) Apache 2.0
+* [**Joda-Convert**](https://github.com/JodaOrg/joda-convert) Apache 2.0
+* [**Material Drawer**](https://github.com/mikepenz/MaterialDrawer) Apache 2.0
+* [**Material Dialogs**](https://github.com/google/guava) MIT
+* [**ButterKnife**](https://github.com/JakeWharton/butterknife/) Apache 2.0
+* [**Android Support Libraries**](http://developer.android.com/tools/support-library/index.html) Apache 2.0
+*Android Support Library requires the corresponding package to be installed in the SDK manager*
+
+##Building
+
+The build process uses gradle. Run `gradle tasks` to see possible tasks,
+`gradle assembleRelease` to assemble a release build and `gradle installDebug`
+to install a debug build on a device connected via `adb`.
+
+To sign your releases, [generate a keypair]() and create a file named
+`signing.gradle` in the `app/` folder with the following content to let gradle
+automatically sign your builds
+
+```groovy
+android {
+ signingConfigs {
+ release {
+ storeFile file("/path/to/your/keystore/here.keystore")
+ storePassword "passwordofyourkeystorehere"
+ keyAlias "nameofyourkeyhere"
+ keyPassword "passwordofyourkeyhere"
+ }
+ }
+
+ buildTypes {
+ release {
+ signingConfig signingConfigs.release
+ }
+ }
+}
+```
+
+##Note
+
+This is a very early alpha version, and should not be used as daily driver
+just yet.
+
+##Authors
+
+*(in chronological order of appearance)*
+
+* **Frederik M. J. Vestre** (freqmod)
+ Initial qdatastream deserialization attempts
+* **Martin "Java Sucks" Sandsmark** (sandsmark)
+ Previous protocol implementation, previous (de)serializers, project (de)moralizer
+* **Magnus Fjell** (magnuf)
+ Legacy UI, Previous Android stuff
+* **Ken Børge Viktil** (Kenji)
+ Legacy UI, Previous Android stuff
+* **Janne Koschinski** (justJanne)
+ New deserialization, Current UI version, Annotation Processors, Push Notification frontend
+* **Pierre-Hugues Husson** (phhusson)
+ Push Notification backend
\ No newline at end of file
diff --git a/app/build.gradle b/app/build.gradle
index a2ccb8c74..f23007b84 100644
--- a/app/build.gradle
+++ b/app/build.gradle
@@ -158,8 +158,8 @@ dependencies {
compile 'com.android.support:cardview-v7:23.1.1'
// Setting autobinding
- compile(name:'aspm-annotations', ext:'jar')
- apt(name:'aspm-compiler', ext:'jar')
+ compile(name:'annotations', ext:'jar')
+ apt(name:'compiler-all', ext:'jar')
// UI autobinding
compile 'com.jakewharton:butterknife:8.0.0-SNAPSHOT'
--
GitLab