Skip to content

Commit 41c1816

Browse files
authored
[Jetcaster] Update README. (#1327)
Update README to reflect the new purpose of the Jetcaster app—to demonstrate building across form factors.
2 parents 8550dce + af9038f commit 41c1816

File tree

3 files changed

+14
-11
lines changed

3 files changed

+14
-11
lines changed

Jetcaster/README.md

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,35 +3,31 @@
33
# Jetcaster sample 🎙️
44

55
Jetcaster is a sample podcast app, built with [Jetpack Compose][compose]. The goal of the sample is to
6-
showcase building with Compose across multiple form factors and full featured architecture.
6+
showcase building with Compose across multiple form factors (mobile, TV, and Wear) and full featured architecture.
77

88
To try out this sample app, use the latest stable version
99
of [Android Studio](https://developer.android.com/studio).
1010
You can clone this repository or import the
1111
project from Android Studio following the steps
1212
[here](https://developer.android.com/jetpack/compose/setup#sample).
1313

14-
### Status: 🚧 In progress 🚧
15-
16-
Jetcaster is still in the early stages of development, and as such only one screen has been created so far. However,
17-
most of the app's architecture has been implemented as well as the data layer.
18-
19-
2014
## Screenshots
2115

2216
![readme_cover](https://github.com/android/compose-samples/assets/10263978/a58ab950-71aa-48e0-8bc7-85443a1b4f6b)
2317

2418
## Features
2519

26-
This sample contains 2 screens so far: the home screen, and a player screen.
20+
This sample has 3 components: the home screen, the podcast details screen, and the player screen
2721

2822
The home screen is split into sub-screens for easy re-use:
2923

30-
- __Home__, allowing the user to see their followed podcasts (top carousel), and navigate between 'Your Library' and 'Discover'
24+
- __Home__, allowing the user to see their subscribed podcasts (top carousel), and navigate between 'Your Library' and 'Discover'
3125
- __Discover__, allowing the user to browse podcast categories
3226
- __Podcast Category__, allowing the user to see a list of recent episodes for podcasts in a given category.
3327

34-
The player screen displays media controls and the currently "playing" podcast (the sample currently doesn't actually play any media).
28+
Multiple panes will also be shown depending on the device's [window size class][wsc].
29+
30+
The player screen displays media controls and the currently "playing" podcast (the sample currently **does not** actually play any media—the behavior is simply mocked).
3531
The player screen layout is adapting to different form factors, including a tabletop layout on foldable devices:
3632

3733
![readme_fold](https://github.com/android/compose-samples/assets/10263978/fe02248f-81ce-489b-a6d6-838438c8368e)
@@ -117,3 +113,4 @@ limitations under the License.
117113
[rome]: https://rometools.github.io/rome/
118114
[jdk8desugar]: https://developer.android.com/studio/write/java8-support#library-desugaring
119115
[coil]: https://coil-kt.github.io/coil/
116+
[wsc]: https://developer.android.com/guide/topics/large-screens/support-different-screen-sizes#window_size_classes

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,10 +79,16 @@ Looking for a sample that has the following features?
7979
* [Jetchat: Downloadable Fonts](https://github.com/android/compose-samples/pull/787)
8080

8181
### Large Screens
82-
* [Jetcaster - Tabletop mode](https://github.com/android/compose-samples/blob/0f7d5958c57a83ecad10136da4d359ae07046d07/Jetcaster/app/src/main/java/com/example/jetcaster/ui/player/PlayerScreen.kt#L138)
82+
* [Jetcaster - Supporting Pane](https://github.com/android/compose-samples/blob/3dbbf0912b57dacefcfb79191a2d7d6b053dadb8/Jetcaster/app/src/main/java/com/example/jetcaster/ui/home/Home.kt#L282)
8383
* [Jetnews - Window Size Classes](https://github.com/android/compose-samples/blob/69e9d862b5ffb321064364d7883e859db6daeccd/JetNews/app/src/main/java/com/example/jetnews/ui/MainActivity.kt#L36)
8484
* [Crane - Window Size Classes](https://github.com/android/compose-samples/blob/e7e8733f9b37d80cdc6e9e05dbabe24ccf20b38f/Crane/app/src/main/java/androidx/compose/samples/crane/home/MainActivity.kt#L72)
8585

86+
### TV
87+
* [Jetcaster - TV](https://github.com/android/compose-samples/tree/3dbbf0912b57dacefcfb79191a2d7d6b053dadb8/Jetcaster/tv-app)
88+
89+
### Wear
90+
* [Jetcaster - Wear](https://github.com/android/compose-samples/tree/3dbbf0912b57dacefcfb79191a2d7d6b053dadb8/Jetcaster/wear)
91+
8692
## Formatting
8793

8894
To automatically format all samples: Run `./scripts/format.sh`

readme/screenshots/Jetcaster.png

104 KB
Loading

0 commit comments

Comments
 (0)