Merge branch 'develop'

Author: danielweck

.github/CONTRIBUTING.md

@@ -0,0 +1,4 @@
+# How to contribute to Readium
+
+Please visit this link for more information:
+http://readium.github.io/contributing.html

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,47 @@
+*General Instructions*
+
+- *Please use a short, but meaningful title.*
+- *Delete everything in italics before submitting issue*
+- *Make sure to fill in as much information as possible*
+
+#### This issue is a Bug|Feature Request|Enhancement|Question|Task|Other
+*(choose ONE from the above list and delete the others)*
+
+#### Related issue(s) and/or pull request(s)
+*Example: See also #NUMBER*
+
+#### Expected Behaviour
+*What you expected Readium to do...*
+
+#### Observed behaviour
+*Instead, Readium does...*
+
+#### Steps to reproduce
+1. First, do this
+2. Then do this
+3. etc.
+
+#### Test file(s)
+*If relevant, please indicate public EPUB URL(s), or whether you can share ebook(s) privately.  It is often next to impossible to reproduce bugs without the original file.*
+
+### Product
+*Choose one of the following (and delete the others)*
+
+* Readium Chrome extension
+  * latest official version available from the Chrome Web Store 
+  * Version of the Chrome browser
+  * OS and version
+* Readium cloud reader app
+  * latest development build uploaded at https://readium.firebaseapp.com OR a custom integration (list public deployment URL, if any)
+  * Browser and version
+  * OS and version
+* Native application (Readium SDK C++)
+  * official "launcher" sample OR propietary app
+  * OS and version
+* Hybrid app (ReadiumJS)
+  * Electron OR Apache Cordova OR ?
+  * OS and version
+* Other?
+
+#### Additional information
+*Please list any additional information that might help us*

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,19 @@
+*General Instructions*
+
+- *Please use a short, but meaningful title.*
+- *Delete everything in italics before submitting the pull request*
+- *Make sure to fill in as much information as possible*
+
+#### This pull request is a Work In Progress|Finalized|Other
+*(choose ONE from the above list and delete the others)*
+
+#### Related issue(s) and/or pull request(s)
+*Example: See also #NUMBER*
+
+#### Test cases, sample files
+
+*(if relevant, please indicate public EPUB URL(s), or whether you can share ebook(s) privately)*
+
+
+### Additional information
+*Please provide any and all information that might help us*

.gitignore

@@ -16,6 +16,8 @@
 # generated files
 bin/
 gen/
+build/
+.gradle/
 
 # Local configuration file (sdk path, etc)
 local.properties
@@ -27,6 +29,10 @@ local.properties
 # IDEA project files
 .idea
 
+SDKLauncher-Android/app/src/main/assets/readium-shared-js/builds
 SDKLauncher-Android/assets/readium-shared-js/epubReadingSystem_.js
 SDKLauncher-Android/.settings/org.eclipse.core.resources.prefs
-SDKLauncher-Android/lint.xml
+SDKLauncher-Android/lint.xml
+
+SDKLauncher-Android/SDKLauncher-Android.iml
+SDKLauncher-Android/app/app.iml

README.md

@@ -13,17 +13,27 @@ develop [![Build Status](http://jenkinsmaster.datalogics-cloud.com:8080/buildSta
 
 How to get source from github
 -------------------------------
- git clone --recursive https://github.com/readium/Launcher-Android.git
+ git clone --recursive https://github.com/readium/SDKLauncher-Android.git
 
-How to build Readium SDK
--------------------------------
+
+Debug C++ code on Android Studio 2
+----------------------------------
+
+Gradle experimental build plugin and Android Studio 2 are required to debug C++ code.
+By default the project uses stable version of gradle plugin but you can switch easily to the experimental one by adding the following line to local.properties file:
 ````
-cd readium-sdk/Platform/Android
-./ndk-compile.sh build your-ndk-path
+readium.ndk_debug=true
 ````
-How to open eclipse project
-----------------------
-Use File->Import... menu, don't use File->New menu 
+
+This settings will switch the build system to the gradle experimental version and allow you to debug, add breakpoints on the C++ code.
+
+You must be careful that if you switch from the stable to the experimental version, you have first to delete all intermediate build files in:
+- Platform/Android/epub3/build
+- Platform/Android/include
+- Platform/Android/obj
+- Platform/Android/libs
+
+If you forget to delete these files, the application will crash because of bad version of shared and static libraries.
 
 Licensing info
 ----------------

SDKLauncher-Android/.classpath

@@ -0,0 +1,53 @@
+if (rootProject.hasProperty("readium_ndk_debug") && rootProject.readium_ndk_debug) {
+    // Use gradle experimental receipt to debug C/C++ code
+    println "${project.name}: Use gradle experimental to build application"
+    apply from: 'build_experimental.gradle'
+} else {
+    apply from: 'build_stable.gradle'
+}
+
+repositories {
+    mavenCentral()
+    flatDir {
+        dirs '../libs'
+    }
+}
+
+dependencies {
+    compile fileTree(dir: '../libs', include: '*.jar')
+}
+
+task buildCssAssets(type: Copy) {
+    from '../../readium-shared-js/build-output/css'
+    into './src/main/assets/readium-shared-js/builds/css'
+}
+
+task buildSingleBundleAssets(type: Copy) {
+    from '../../readium-shared-js/build-output/_multiple-bundles'
+    into './src/main/assets/readium-shared-js/builds/multiple-bundle'
+}
+
+task buildMultipleBundleAssets(type: Copy) {
+    from '../../readium-shared-js/build-output/_single-bundle'
+    into './src/main/assets/readium-shared-js/builds/single-bundle'
+}
+
+task buildAssets {
+    println "Build Js Assets"
+}
+
+buildAssets.dependsOn "buildCssAssets",
+        "buildSingleBundleAssets",
+        "buildMultipleBundleAssets"
+
+apply from: 'build_epubReadingSystem.gradle'
+
+tasks.whenTaskAdded { task ->
+    def taskName = task.name
+
+    if (taskName.startsWith("compile")) {
+        task.dependsOn "buildAssets",
+            ":epub3:buildMk",
+            "buildEpubReadingSystem"
+    }
+}