Skip to content

Update README files for each area #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Apr 17, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 23 additions & 1 deletion samples/accessibility/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,25 @@
# Accessibility Samples

This is a catalog of accessibility-specific APIs to demonstrate the usage of each API.
This is a catalog of accessibility-specific APIs to demonstrate the usage of each API.

More info at
- [Accessibility Overview](https://developer.android.com/guide/topics/ui/accessibility)
- [Accessibility in Compose](https://developer.android.com/jetpack/compose/accessibility)

## License

```
Copyright 2022 The Android Open Source Project

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```
9 changes: 7 additions & 2 deletions samples/connectivity/audio/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
# Connectivity samples
# Audio samples

> Audio Manager Sample Complete
This module includes Audio Samples around Android Platform

- [Audio Manager](src/main/java/com/example/platform/connectivity/audio/AudioSample.kt)

For more check out the documentation at
https://developer.android.com/guide/topics/media

## License

Expand Down
11 changes: 8 additions & 3 deletions samples/connectivity/bluetooth/ble/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
# FindDevicesSample samples
# Bluetooth Low Energy (BLE) samples

// TODO
This moudle contains samples related to Bluetooth BLE APIs

- [Find devices](src/main/java/com/example/platform/connectivity/bluetooth/ble/FindDevicesSample.kt)

More info at
https://developer.android.com/guide/topics/connectivity/bluetooth/ble-overview

## License

Expand All @@ -18,4 +23,4 @@ distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```
```
17 changes: 8 additions & 9 deletions samples/location/README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,17 @@
# Location samples

The samples in this directory address various scenarios of building location aware apps
[Location Permissions](src/main/java/com/example/platform/location/permission/LocationPermissionsScreen.kt)
[Get Current Location](src/main/java/com/example/platform/location/currentLocation/CurrentLocationScreen.kt)
[Receive Location Updates](src/main/java/com/example/platform/location/locationupdates/LocationUpdatesScreen.kt)
[Background Location Access](src/main/java/com/example/platform/location/bglocationaccess/BgLocationAccessScreen.kt)
[Create and Monitor Geofences](src/main/java/com/example/platform/location/geofencing/GeofencingScreen.kt)
[User Activity Recognition](src/main/java/com/example/platform/location/useractivityrecog/UserActivityRecognitionScreen.kt)
- [Location Permissions](src/main/java/com/example/platform/location/permission/LocationPermissionsScreen.kt)
- [Get Current Location](src/main/java/com/example/platform/location/currentLocation/CurrentLocationScreen.kt)
- [Receive Location Updates](src/main/java/com/example/platform/location/locationupdates/LocationUpdatesScreen.kt)
- [Background Location Access](src/main/java/com/example/platform/location/bglocationaccess/BgLocationAccessScreen.kt)
- [Create and Monitor Geofences](src/main/java/com/example/platform/location/geofencing/GeofencingScreen.kt)
- [User Activity Recognition](src/main/java/com/example/platform/location/useractivityrecog/UserActivityRecognitionScreen.kt)

> **Important:** All samples run independent of each other.

These samples showcase the use case in a simplified manner. For more details on how to build location
aware apps please refer
https://developer.android.com/training/location
aware apps please refer https://developer.android.com/training/location

## License

Expand All @@ -30,4 +29,4 @@ distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```
```
2 changes: 1 addition & 1 deletion samples/user-interface/text/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ attribute to apply automatic hyphenation to a `TextView`.
Android 13 (API level 33) introduced 2 new options, `fullFast` and `normalFast`. These are the same
as `full` and `normal`, but use faster algorithm for better performance.

### [Line break]src/main/java/com/example/platform/ui/text/LineBreak.kt)
### [Line break](src/main/java/com/example/platform/ui/text/LineBreak.kt)

This feature is relevant to _languages written without spaces between words_, such as Japanese and
Chinese. This particular demo works only when the device locale is set to Japanese.
Expand Down