Skip to content
This repository was archived by the owner on Jun 19, 2021. It is now read-only.

Commit a9889cb

Browse files
riggarooriggaroo
committed
Fixed Readme and added binary upload
1 parent acf5a82 commit a9889cb

6 files changed

Lines changed: 131 additions & 96 deletions

File tree

‎.gitignore‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,5 @@
77
/captures
88
/.idea/
99
*.iml
10+
11+
*.iml

‎README.md‎

Lines changed: 36 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,16 @@ Android Library demonstrating a material intro tutorial much like the ones on Go
44
This library shows a help or introduction tutorial into your application. Its inspired by the one in the Google Sheets Android app.
55
The help tutorial takes the background colour set for each page and when scrolling between the two pages, the two colours will fade into one another.
66

7+
[ ![Download](https://api.bintray.com/packages/spongebobrf/maven/MaterialIntroTutorial/images/download.svg) ](https://bintray.com/spongebobrf/maven/MaterialIntroTutorial/_latestVersion)
78

89
# Example Usage
910

1011
Add the following into your build.gradle:
11-
12-
compile "za.co.riggaroo.materialhelptutorial:material-tutorial:1.0.0"
13-
12+
```groovy
13+
compile 'za.co.riggaroo:materialhelptutorial:1.0.0'
14+
```
1415
In your activity, create a list of TutorialItems (set the title, subtitle, background colour and image drawable int). Pass them onto the MaterialTutorialActivity and start the activity for result.
15-
16+
```android
1617
public void loadTutorial() {
1718
Intent mainAct = new Intent(this, MaterialTutorialActivity.class);
1819
mainAct.putParcelableArrayListExtra(MaterialTutorialActivity.MATERIAL_TUTORIAL_ARG_TUTORIAL_ITEMS, getTutorialItems(this));
@@ -32,13 +33,42 @@ In your activity, create a list of TutorialItems (set the title, subtitle, backg
3233
3334
return tutorialItems;
3435
}
35-
36+
```
3637
You should see a tutorial like below:
3738
![](example-usage.gif)
3839

3940
This library is using the following:
4041
- CirclePageIndicator
41-
- UniversalImageLoader
42+
- Glide for image loading
4243
- Percent Support Library
4344

4445

46+
# License
47+
48+
Copyright (c) 2015 Rebecca Franks
49+
50+
Permission is hereby granted, free of charge, to any person obtaining a copy
51+
of this software and associated documentation files (the "Software"), to deal
52+
in the Software without restriction, including without limitation the rights
53+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
54+
copies of the Software, and to permit persons to whom the Software is
55+
furnished to do so, subject to the following conditions:
56+
57+
58+
59+
The above copyright notice and this permission notice shall be included in
60+
all copies or substantial portions of the Software.
61+
62+
63+
64+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
65+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
66+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
67+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
68+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
69+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
70+
THE SOFTWARE.
71+
72+
73+
74+

‎build.gradle‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@ buildscript {
66
}
77
dependencies {
88
classpath 'com.android.tools.build:gradle:1.3.0'
9-
9+
classpath 'com.jfrog.bintray.gradle:gradle-bintray-plugin:1.4'
10+
classpath 'com.github.dcendents:android-maven-gradle-plugin:1.3'
1011
// NOTE: Do not place your application dependencies here; they belong
1112
// in the individual module build.gradle files
1213
}

‎materialhelptutorial/build.gradle‎

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,12 @@
11
apply plugin: 'com.android.library'
2+
apply plugin: 'com.github.dcendents.android-maven'
3+
apply plugin: 'com.jfrog.bintray'
4+
5+
version = "1.0.0"
6+
group = "za.co.riggaroo"
7+
8+
def siteUrl = 'https://github.com/spongebobrf/MaterialIntroTutorial'
9+
def gitUrl = 'https://github.com/spongebobrf/MaterialIntroTutorial.git'
210

311
android {
412
compileSdkVersion 23
@@ -25,3 +33,79 @@ dependencies {
2533
compile 'com.android.support:percent:23.1.0'
2634
compile 'com.github.bumptech.glide:glide:3.6.0'
2735
}
36+
37+
38+
39+
bintray {
40+
user = BINTRAY_USER
41+
key = BINTRAY_KEY
42+
43+
configurations = ['archives']
44+
pkg {
45+
repo = "maven"
46+
name = "MaterialIntroTutorial"
47+
websiteUrl = siteUrl
48+
vcsUrl = gitUrl
49+
licenses = ["Apache-2.0"]
50+
publish = true
51+
}
52+
}
53+
54+
55+
install {
56+
repositories.mavenInstaller {
57+
pom {
58+
project {
59+
packaging 'aar'
60+
61+
name 'Android Library for a material intro tutorial'
62+
url siteUrl
63+
licenses {
64+
license {
65+
name 'The Apache Software License, Version 2.0'
66+
url 'http://www.apache.org/licenses/LICENSE-2.0.txt'
67+
}
68+
}
69+
developers {
70+
developer {
71+
id 'riggaroo'
72+
name 'Rebecca Franks'
73+
email 'franks.rebecca@gmail.com'
74+
}
75+
}
76+
scm {
77+
connection gitUrl
78+
developerConnection gitUrl
79+
url siteUrl
80+
81+
}
82+
}
83+
}
84+
}
85+
}
86+
task sourcesJar(type: Jar) {
87+
from android.sourceSets.main.java.srcDirs
88+
classifier = 'sources'
89+
}
90+
91+
task javadoc(type: Javadoc) {
92+
source = android.sourceSets.main.java.srcDirs
93+
classpath += project.files(android.getBootClasspath().join(File.pathSeparator))
94+
}
95+
96+
task javadocJar(type: Jar, dependsOn: javadoc) {
97+
classifier = 'javadoc'
98+
from javadoc.destinationDir
99+
}
100+
101+
artifacts {
102+
archives javadocJar
103+
archives sourcesJar
104+
}
105+
106+
task findConventions << {
107+
println project.getConvention()
108+
}
109+
110+
task wrapper(type: Wrapper) {
111+
}

‎materialhelptutorial/materialhelptutorial.iml‎

Lines changed: 5 additions & 89 deletions
Original file line numberDiff line numberDiff line change
@@ -1,105 +1,21 @@
11
<?xml version="1.0" encoding="UTF-8"?>
2-
<module external.linked.project.id=":materialhelptutorial" external.linked.project.path="$MODULE_DIR$" external.root.project.path="$MODULE_DIR$/.." external.system.id="GRADLE" external.system.module.group="HelpTutorialExample" external.system.module.version="unspecified" type="JAVA_MODULE" version="4">
2+
<module external.linked.project.id="materialhelptutorial" external.linked.project.path="$MODULE_DIR$/.." external.root.project.path="$MODULE_DIR$/.." external.system.id="GRADLE" external.system.module.group="" external.system.module.version="unspecified" type="JAVA_MODULE" version="4">
33
<component name="FacetManager">
4-
<facet type="android-gradle" name="Android-Gradle">
5-
<configuration>
6-
<option name="GRADLE_PROJECT_PATH" value=":materialhelptutorial" />
7-
</configuration>
8-
</facet>
94
<facet type="java-gradle" name="Java-Gradle">
105
<configuration>
11-
<option name="BUILD_FOLDER_PATH" value="$MODULE_DIR$/build" />
6+
<option name="BUILD_FOLDER_PATH" value="$MODULE_DIR$/../build" />
127
<option name="BUILDABLE" value="false" />
138
</configuration>
149
</facet>
15-
<facet type="android" name="Android">
16-
<configuration>
17-
<option name="SELECTED_BUILD_VARIANT" value="debug" />
18-
<option name="SELECTED_TEST_ARTIFACT" value="_android_test_" />
19-
<option name="ASSEMBLE_TASK_NAME" value="assembleDebug" />
20-
<option name="COMPILE_JAVA_TASK_NAME" value="compileDebugSources" />
21-
<option name="ASSEMBLE_TEST_TASK_NAME" value="assembleDebugAndroidTest" />
22-
<option name="COMPILE_JAVA_TEST_TASK_NAME" value="compileDebugAndroidTestSources" />
23-
<afterSyncTasks>
24-
<task>generateDebugAndroidTestSources</task>
25-
<task>generateDebugSources</task>
26-
</afterSyncTasks>
27-
<option name="ALLOW_USER_CONFIGURATION" value="false" />
28-
<option name="MANIFEST_FILE_RELATIVE_PATH" value="/src/main/AndroidManifest.xml" />
29-
<option name="RES_FOLDER_RELATIVE_PATH" value="/src/main/res" />
30-
<option name="RES_FOLDERS_RELATIVE_PATH" value="file://$MODULE_DIR$/src/main/res" />
31-
<option name="ASSETS_FOLDER_RELATIVE_PATH" value="/src/main/assets" />
32-
<option name="LIBRARY_PROJECT" value="true" />
33-
</configuration>
34-
</facet>
3510
</component>
36-
<component name="NewModuleRootManager" LANGUAGE_LEVEL="JDK_1_7" inherit-compiler-output="false">
11+
<component name="NewModuleRootManager" LANGUAGE_LEVEL="JDK_1_7" inherit-compiler-output="true">
3712
<output url="file://$MODULE_DIR$/build/intermediates/classes/debug" />
3813
<output-test url="file://$MODULE_DIR$/build/intermediates/classes/androidTest/debug" />
3914
<exclude-output />
40-
<content url="file://$MODULE_DIR$">
41-
<sourceFolder url="file://$MODULE_DIR$/build/generated/source/r/debug" isTestSource="false" generated="true" />
42-
<sourceFolder url="file://$MODULE_DIR$/build/generated/source/aidl/debug" isTestSource="false" generated="true" />
43-
<sourceFolder url="file://$MODULE_DIR$/build/generated/source/buildConfig/debug" isTestSource="false" generated="true" />
44-
<sourceFolder url="file://$MODULE_DIR$/build/generated/source/rs/debug" isTestSource="false" generated="true" />
45-
<sourceFolder url="file://$MODULE_DIR$/build/generated/res/rs/debug" type="java-resource" />
46-
<sourceFolder url="file://$MODULE_DIR$/build/generated/res/resValues/debug" type="java-resource" />
47-
<sourceFolder url="file://$MODULE_DIR$/build/generated/source/r/androidTest/debug" isTestSource="true" generated="true" />
48-
<sourceFolder url="file://$MODULE_DIR$/build/generated/source/aidl/androidTest/debug" isTestSource="true" generated="true" />
49-
<sourceFolder url="file://$MODULE_DIR$/build/generated/source/buildConfig/androidTest/debug" isTestSource="true" generated="true" />
50-
<sourceFolder url="file://$MODULE_DIR$/build/generated/source/rs/androidTest/debug" isTestSource="true" generated="true" />
51-
<sourceFolder url="file://$MODULE_DIR$/build/generated/res/rs/androidTest/debug" type="java-test-resource" />
52-
<sourceFolder url="file://$MODULE_DIR$/build/generated/res/resValues/androidTest/debug" type="java-test-resource" />
53-
<sourceFolder url="file://$MODULE_DIR$/src/debug/res" type="java-resource" />
54-
<sourceFolder url="file://$MODULE_DIR$/src/debug/resources" type="java-resource" />
55-
<sourceFolder url="file://$MODULE_DIR$/src/debug/assets" type="java-resource" />
56-
<sourceFolder url="file://$MODULE_DIR$/src/debug/aidl" isTestSource="false" />
57-
<sourceFolder url="file://$MODULE_DIR$/src/debug/java" isTestSource="false" />
58-
<sourceFolder url="file://$MODULE_DIR$/src/debug/jni" isTestSource="false" />
59-
<sourceFolder url="file://$MODULE_DIR$/src/debug/rs" isTestSource="false" />
60-
<sourceFolder url="file://$MODULE_DIR$/src/main/res" type="java-resource" />
61-
<sourceFolder url="file://$MODULE_DIR$/src/main/resources" type="java-resource" />
62-
<sourceFolder url="file://$MODULE_DIR$/src/main/assets" type="java-resource" />
63-
<sourceFolder url="file://$MODULE_DIR$/src/main/aidl" isTestSource="false" />
64-
<sourceFolder url="file://$MODULE_DIR$/src/main/java" isTestSource="false" />
65-
<sourceFolder url="file://$MODULE_DIR$/src/main/jni" isTestSource="false" />
66-
<sourceFolder url="file://$MODULE_DIR$/src/main/rs" isTestSource="false" />
67-
<sourceFolder url="file://$MODULE_DIR$/src/androidTest/res" type="java-test-resource" />
68-
<sourceFolder url="file://$MODULE_DIR$/src/androidTest/resources" type="java-test-resource" />
69-
<sourceFolder url="file://$MODULE_DIR$/src/androidTest/assets" type="java-test-resource" />
70-
<sourceFolder url="file://$MODULE_DIR$/src/androidTest/aidl" isTestSource="true" />
71-
<sourceFolder url="file://$MODULE_DIR$/src/androidTest/java" isTestSource="true" />
72-
<sourceFolder url="file://$MODULE_DIR$/src/androidTest/jni" isTestSource="true" />
73-
<sourceFolder url="file://$MODULE_DIR$/src/androidTest/rs" isTestSource="true" />
74-
<excludeFolder url="file://$MODULE_DIR$/build/intermediates/assets" />
75-
<excludeFolder url="file://$MODULE_DIR$/build/intermediates/bundles" />
76-
<excludeFolder url="file://$MODULE_DIR$/build/intermediates/classes" />
77-
<excludeFolder url="file://$MODULE_DIR$/build/intermediates/coverage-instrumented-classes" />
78-
<excludeFolder url="file://$MODULE_DIR$/build/intermediates/dependency-cache" />
79-
<excludeFolder url="file://$MODULE_DIR$/build/intermediates/dex" />
80-
<excludeFolder url="file://$MODULE_DIR$/build/intermediates/dex-cache" />
81-
<excludeFolder url="file://$MODULE_DIR$/build/intermediates/exploded-aar/com.android.support/appcompat-v7/23.0.1/jars" />
82-
<excludeFolder url="file://$MODULE_DIR$/build/intermediates/incremental" />
83-
<excludeFolder url="file://$MODULE_DIR$/build/intermediates/jacoco" />
84-
<excludeFolder url="file://$MODULE_DIR$/build/intermediates/javaResources" />
85-
<excludeFolder url="file://$MODULE_DIR$/build/intermediates/libs" />
86-
<excludeFolder url="file://$MODULE_DIR$/build/intermediates/lint" />
87-
<excludeFolder url="file://$MODULE_DIR$/build/intermediates/manifests" />
88-
<excludeFolder url="file://$MODULE_DIR$/build/intermediates/ndk" />
89-
<excludeFolder url="file://$MODULE_DIR$/build/intermediates/pre-dexed" />
90-
<excludeFolder url="file://$MODULE_DIR$/build/intermediates/proguard" />
91-
<excludeFolder url="file://$MODULE_DIR$/build/intermediates/res" />
92-
<excludeFolder url="file://$MODULE_DIR$/build/intermediates/rs" />
93-
<excludeFolder url="file://$MODULE_DIR$/build/intermediates/symbols" />
94-
<excludeFolder url="file://$MODULE_DIR$/build/outputs" />
95-
<excludeFolder url="file://$MODULE_DIR$/build/tmp" />
15+
<content url="file://$MODULE_DIR$/..">
16+
<excludeFolder url="file://$MODULE_DIR$/../.gradle" />
9617
</content>
9718
<orderEntry type="jdk" jdkName="Android API 23 Platform" jdkType="Android SDK" />
9819
<orderEntry type="sourceFolder" forTests="false" />
99-
<orderEntry type="library" exported="" name="support-annotations-23.1.0" level="project" />
100-
<orderEntry type="library" exported="" name="percent-23.1.0" level="project" />
101-
<orderEntry type="library" exported="" name="appcompat-v7-23.0.1" level="project" />
102-
<orderEntry type="library" exported="" name="glide-3.6.0" level="project" />
103-
<orderEntry type="library" exported="" name="support-v4-23.1.0" level="project" />
10420
</component>
10521
</module>

‎settings.gradle‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
11
include ':app', "materialhelptutorial"
2+
3+
rootProject.name = 'materialhelptutorial'

0 commit comments

Comments
 (0)