added documents

kiruto · Oct 28, 2016 · 14dcc8b · 14dcc8b
1 parent 2026b12
commit 14dcc8b
Show file tree

Hide file tree

Showing 4 changed files with 83 additions and 1 deletion.
diff --git a/TODO.md b/TODO.md
@@ -14,11 +14,11 @@
 # 1.0.1
 - [x] UI: quick toggles
 - [x] feature: display FPS
+- [ ] feature: display intent arguments
 
 # 1.1
 - [ ] fix: support OkHttp3
 - [ ] feature: services manager
-- [ ] feature: display intent arguments
 - [ ] feature: content provider manager
 - [ ] feature: SQLite editor
 - [ ] feature: fragment previewer without activity

diff --git a/docs/zh-CN/contribute.md b/docs/zh-CN/contribute.md
@@ -0,0 +1,9 @@
+[目录](../README.md)>项目建设
+
+# 项目建设
+
+## 代码提交
+本项目目前支持最低support包appcompat-v7版本为22，使用不同分支提供支持。一般为"v22/版本号"，"v23/版本号"等方式命名分支，主分支直接以版本号命名。
+本工程提供了一个基本(bash)脚本[sync_branches.sh](../../sync_branches.sh)同步各分支，若需要将代码同步到不同分支，需先commit后执行脚本。
+一般情况下可以提交push request至主分支即可；在支持不同版本support包产生分歧的情况下，需要执行脚本同步，并提交push request到不同分支。
+旧support包支持可能不会被永久维护。
diff --git a/docs/zh-CN/tutorial/README.md b/docs/zh-CN/tutorial/README.md
@@ -1,3 +1,5 @@
+[目录](../README.md)>简介
+
 # 简介
 在Android开发过程中，会遇到各种小问题，熟练的开发者有自己解决小问题的套路。为了节约解决小问题的成本，我开发了Debug Bottle：一套小问题的解决方案。
 ## 什么是Debug Bottle

diff --git a/docs/zh-CN/tutorial/quick-start.md b/docs/zh-CN/tutorial/quick-start.md
@@ -0,0 +1,71 @@
+[目录](../README.md)>快速使用
+
+# 快速使用
+
+## 添加依赖
+如果你的工程使用Gradle构建，可以按照本页方法添加Debug Bottle依赖。以1.0.4版本为例：
+
+```gradle
+dependencies {
+    // Debug Bottle的主体内容，仅在Debug时被编译进去
+    debugCompile 'com.exyui.android:debug-bottle-runtime:1.0.4'
+    
+    // 使用不同support包，选择正确的依赖
+    // debugCompile 'com.exyui.android:debug-bottle-runtime:1.0.4-support22'
+    // debugCompile 'com.exyui.android:debug-bottle-runtime:1.0.4-support23'
+
+    // 如果工程使用的是Java语言，添加以下依赖
+    releaseCompile 'com.exyui.android:debug-bottle-noop-java:1.0.4'
+    testCompile 'com.exyui.android:debug-bottle-noop-java:1.0.4'
+
+    // 如果工程实用的是Kotlin，添加以下依赖
+    releaseCompile 'com.exyui.android:debug-bottle-noop-kotlin:1.0.4'
+    testCompile 'com.exyui.android:debug-bottle-noop-kotlin:1.0.4'
+
+    // 加入你的support包支持
+    compile 'com.android.support:appcompat-v7:23.2.0+'
+    // 或使用v22版
+    // compile 'com.android.support:appcompat-v7:22+'
+}
+```
+
+## 编辑Manifest
+
+添加这些内容到Manifest
+```xml
+<activity
+    android:name="com.exyui.android.debugbottle.components.DTDrawerActivity"
+    android:theme="@style/Theme.AppCompat.Light"
+    android:label="The Name You Like"/>
+```
+这是Debug Bottle的主要入口。label属性表示图标名称，可以随意修改。若没有label属性，则Debug Bottle图标名称和你的App图标名称一致。
+
+## 嵌入App
+
+首先，应实现BlockCanaryContext接口：
+```java
+// 实现各种上下文，包括应用标示符，用户uid，网络类型，卡慢判断阙值，Log保存位置等
+public class AppBlockCanaryContext extends BlockCanaryContext {
+    //...
+}
+```
+需要实现的方法可以参照注释：[BlockCanaryContext](../../../blockcanary/src/main/kotlin/com/exyui/android/debugbottle/ui/BlockCanaryContext.kt)
+实现示例：[AppBlockCanaryContext](../../../demo/src/main/kotlin/me/chunyu/dev/yuriel/kotdebugtool/AppBlockCanaryContext.kt)
+
+现在可以将Debug Bottle注入到App中：
+```java
+public class MyApplication extends Application{
+    @Override
+    public void onCreate() {
+        super.onCreate();
+        DTInstaller.install(this)
+            .setBlockCanary(new AppBlockCanaryContext(this))
+            .setOkHttpClient(httpClient)
+            .setInjector("your.package.injector.ContentInjector")
+            .setPackageName("your.package")
+            .enable()
+            .run();
+    }
+}
+```
+现在完成了Debug Bottle的嵌入。