davidliu
Committed by GitHub

Update README.md (#166)

* Update README.md

* Add TOC
正在显示 1 个修改的文件 包含 27 行增加1 行删除
@@ -3,6 +3,21 @@ @@ -3,6 +3,21 @@
3 Official Android Client SDK for [LiveKit](https://github.com/livekit/livekit-server). Easily add 3 Official Android Client SDK for [LiveKit](https://github.com/livekit/livekit-server). Easily add
4 video & audio capabilities to your Android apps. 4 video & audio capabilities to your Android apps.
5 5
  6 +Table of Contents
  7 +=================
  8 +
  9 + * [Docs](#docs)
  10 + * [Installation](#installation)
  11 + * [Usage](#usage)
  12 + * [Permissions](#permissions)
  13 + * [Publishing camera and microphone](#publishing-camera-and-microphone)
  14 + * [Sharing screen](#sharing-screen)
  15 + * [Rendering subscribed tracks](#rendering-subscribed-tracks)
  16 + * [@FlowObservable](#flowobservable)
  17 + * [Sample App](#sample-app)
  18 + * [Dev Environment](#dev-environment)
  19 + * [Optional (Dev convenience)](#optional-dev-convenience)
  20 +
6 ## Docs 21 ## Docs
7 22
8 Docs and guides at [https://docs.livekit.io](https://docs.livekit.io). 23 Docs and guides at [https://docs.livekit.io](https://docs.livekit.io).
@@ -165,6 +180,8 @@ coroutineScope.launch { @@ -165,6 +180,8 @@ coroutineScope.launch {
165 180
166 ## Sample App 181 ## Sample App
167 182
  183 +**Note**: If you wish to run the sample apps directly from this repo, please consult the [Dev Environment instructions](#dev-environment).
  184 +
168 We have a basic quickstart sample 185 We have a basic quickstart sample
169 app [here](https://github.com/livekit/client-sdk-android/blob/main/sample-app-basic), showing how to 186 app [here](https://github.com/livekit/client-sdk-android/blob/main/sample-app-basic), showing how to
170 connect to a room, publish your device's audio/video, and display the video of one remote participant. 187 connect to a room, publish your device's audio/video, and display the video of one remote participant.
@@ -189,7 +206,16 @@ participant's UI. @@ -189,7 +206,16 @@ participant's UI.
189 206
190 To develop the Android SDK or running the sample app directly from this repo, you'll need: 207 To develop the Android SDK or running the sample app directly from this repo, you'll need:
191 208
192 -- Ensure the protocol submodule repo is initialized and updated with `git submodule update --init` 209 +- Clone the repo to your computer
  210 +- Ensure the protocol submodule repo is initialized and updated
  211 +
  212 +```
  213 +git clone https://github.com/livekit/client-sdk-android.git
  214 +cd client-sdk-android
  215 +git submodule update --init
  216 +```
  217 +
  218 +----
193 219
194 For those developing on Apple M1 Macs, please add below to $HOME/.gradle/gradle.properties 220 For those developing on Apple M1 Macs, please add below to $HOME/.gradle/gradle.properties
195 221