Skip to content

Commit 1e205a2

Browse files
committed
Update README.md
1 parent a2c0159 commit 1e205a2

File tree

2 files changed

+33
-58
lines changed

2 files changed

+33
-58
lines changed

AdaptiveJetStream/README.md

Lines changed: 33 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -1,73 +1,48 @@
1-
# Jetpack Compose for TVSamples
2-
3-
This repository contains a set of individual Android Studio projects to help you learn about
4-
Compose in Android TV. Each sample demonstrates different use cases, complexity levels and APIs.
5-
6-
For more information, please [read the documentation](https://developer.android.com/jetpack/androidx/releases/tv)
7-
8-
💻 Requirements
9-
------------
10-
To try out these sample apps, you need to use [Android Studio](https://developer.android.com/studio).
11-
You can clone this repository or import the
12-
project from Android Studio following the steps
13-
[here](https://developer.android.com/jetpack/compose/setup#sample).
14-
15-
🧬 Samples
16-
------------
17-
18-
### JetStream
19-
20-
A sample media streaming app that demonstrates the use of TV Compose with a typical Material app and
21-
real-world architecture.
22-
23-
* Dark themed
24-
* Showcases
25-
* TabRow
26-
* Carousel
27-
* TvLazyRow
28-
* ImmersiveList
29-
* TvLazyColumn
30-
* Tv Material Surface
31-
* TvVerticalGrid
32-
* Tv Material Cards
33-
* Buttons
34-
* Icon
35-
* Text
36-
* Chips
37-
* ListItem
38-
* Switch
39-
* Dialogs
40-
41-
## Screenshots
42-
43-
![List of screenshots from the JetStream sample application](./Screenshots.png)
1+
# **Adaptive Apps Samples: JetStream**
442

45-
## Performance
3+
Jetstream is a sample media streaming application designed to adapt to various form factors using a single binary. It leverages Compose Material3 for cross-device compatibility, enabling [adaptive experiences](https://developer.android.com/adaptive-apps) across different form factors.
464

47-
### Benchmarks
5+
* Mobile device
6+
* Tablet
7+
* Foldable device
8+
* Chromebook
9+
* TV
10+
* Automotive
11+
* XR device
4812

49-
The `benchmarks` module contains sample tests written using [`Macrobenchmark`](https://developer.android.com/studio/profile/macrobenchmark) library. It also contains the test to generate the baseline profile for JetStream app.
13+
![Home screens on different form factors](Screenshots.png)
5014

51-
### Baseline profiles
15+
This directory contains a version of the JetStream TV sample app that utilizes [Compose Material3](https://developer.android.com/jetpack/androidx/releases/compose-material3) components, with some exceptions like the [featured carousel](https://developer.android.com/design/ui/tv/guides/components/featured-carousel). It builds upon the original JetStream sample to offer experiences tailored to different device form factors. The original JetStream app for TV can be found at [https://github.com/android/tv-samples/](https://github.com/android/tv-samples/).
16+
17+
## Requirements
18+
19+
* You need Android Studio to try the sample app.
20+
* If you are trying JetStream on XR emulator, refer to [this document](https://developer.android.com/develop/xr/jetpack-xr-sdk/setup) for the details.
21+
* You can clone this repository and build the sample app in AdaptiveJetStream directory. Refer to [this document](https://developer.android.com/jetpack/compose/setup#sample) for the steps.
22+
23+
## Performance
5224

53-
The baseline profile for this app is located at [`jetstream/src/main/baseline-prof.txt`](jetstream/src/main/baseline-prof.txt). It contains rules that enable AOT compilation of the critical user path taken during app launch. To learn more about baseline profiles, read [here](https://developer.android.com/studio/profile/baselineprofiles).
25+
The `benchmarks` module contains sample tests written using the [Macrobenchmark](https://developer.android.com/studio/profile/macrobenchmark) library. It also contains the test to generate the baseline profile for JetStream app.
5426

55-
For more details on how to generate & apply baseline profiles, check [this document](baseline-profiles.md).
27+
### Baseline profiles
5628

29+
The baseline profile for this app is generated as `jetstream/src/release/generated/baselineProfiles/baseline-prof.txt`, which contains rules that enable AOT compilation of the critical user path taken during app launch. Refer to this [document](https://developer.android.com/studio/profile/baselineprofiles) to learn more about baseline profiles
5730

5831
## License
59-
```
60-
Copyright 2023 Google LLC
6132

62-
Licensed under the Apache License, Version 2.0 (the "License");
63-
you may not use this file except in compliance with the License.
33+
```
34+
Copyright 2025 Google LLC
35+
36+
Licensed under the Apache License, Version 2.0 (the "License");
37+
you may not use this file except in compliance with the License.
6438
You may obtain a copy of the License at
6539
6640
https://www.apache.org/licenses/LICENSE-2.0
6741
68-
Unless required by applicable law or agreed to in writing, software
69-
distributed under the License is distributed on an "AS IS" BASIS,
70-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
71-
See the License for the specific language governing permissions and
72-
limitations under the License.
42+
Unless required by applicable law or agreed to in writing, software
43+
distributed under the License is distributed on an "AS IS" BASIS,
44+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
45+
See the License for the specific language governing permissions and
46+
limitations under the License.
7347
```
48+

AdaptiveJetStream/Screenshots.png

970 KB
Loading

0 commit comments

Comments
 (0)