Skip to content

Commit ecec66d

Browse files
committed
Add links from top-level README to other READMEs.
Asked Gemini to add links to more specific READMEs from the top-level README to help developers understand the structure of the app.
1 parent bc7714a commit ecec66d

File tree

3 files changed

+10
-20
lines changed

3 files changed

+10
-20
lines changed

README.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -47,16 +47,15 @@ The project is organized into several modules and directories:
4747
- `app/`: Contains the main Android application code.
4848
- `src/main/`: Source code and resources for the main application.
4949
- `java/`: Kotlin/Java source files.
50-
- `com/google/android/samples/socialite/`: The main package for the application.
51-
- `data/`: Data sources, repositories, and related logic.
52-
- `model/`: Data models and entities.
53-
- `ui/`: UI components, screens, and view models.
54-
- `camera/`: Code related to the in-app camera feature.
55-
- `chat/`: Code for the chat list and individual chat screens.
56-
- `settings/`: Code for the settings screen.
57-
- `timeline/`: Code for the timeline screen.
58-
- `videoedit/`: Code for the video editing screen.
59-
- `util/`: Utility classes and helper functions.
50+
- `com/google/android/samples/socialite/`: The main package for the application. See the [README](app/src/main/java/com/google/android/samples/socialite/README.md) for more details.
51+
- `data/`: Data sources, repositories, and related logic. See the [README](app/src/main/java/com/google/android/samples/socialite/data/README.md) for more details.
52+
- `model/`: Data models and entities. See the [README](app/src/main/java/com/google/android/samples/socialite/model/README.md) for more details.
53+
- `ui/`: UI components, screens, and view models. See the [README](app/src/main/java/com/google/android/samples/socialite/ui/README.md) for more details.
54+
- `camera/`: Code related to the in-app camera feature. See the [README](app/src/main/java/com/google/android/samples/socialite/ui/camera/README.md) for more details.
55+
- `chat/`: Code for the chat list and individual chat screens. See the [README](app/src/main/java/com/google/android/samples/socialite/ui/chat/README.md) for more details.
56+
- `settings/`: Code for the settings screen. See the [README](app/src/main/java/com/google/android/samples/socialite/ui/home/settings/README.md) for more details.
57+
- `timeline/`: Code for the timeline screen. See the [README](app/src/main/java/com/google/android/samples/socialite/ui/home/timeline/README.md) for more details.
58+
- `videoedit/`: Code for the video editing screen. See the [README](app/src/main/java/com/google/android/samples/socialite/ui/videoedit/README.md) for more details.
6059
- `res/`: Application resources (layouts, drawables, values, etc.).
6160
- `assets/`: Static assets like images and shaders.
6261
- `build.gradle.kts`: Gradle build file for the app module.

app/src/main/java/com/google/android/samples/socialite/ui/home/timeline/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Timeline Module
22

3-
This directory contains the code for the timeline screen of the SociaLite application. This screen displays a vertical feed of all photos and videos shared across all chat threads.
3+
This directory contains the code for the timeline screen of the SociaLite application. This screen displays a vertical feed of all photos and videos shared across all chat threads. This screen uses `PreloadManagerWrapper.kt` which builds on ExoPlayer's [DefaultPreloadManager](https://developer.android.com/reference/androidx/media3/exoplayer/source/preload/DefaultPreloadManager) to enable smooth vertical scrolling between media items.
44

55
- **Timeline UI:** Jetpack Compose composables (e.g., `TimelineScreen.kt`) for displaying the list of media items (photos and videos) in a scrollable feed. This involves displaying the media content and potentially some associated information like the sender or timestamp.
66
- **ViewModel Logic:** A ViewModel (e.g., `TimelineViewModel`) to manage the state and logic for the timeline screen. This ViewModel is responsible for fetching the list of media items from the data layer and exposing it to the UI.

app/src/main/java/com/google/android/samples/socialite/ui/timeline/README.md

Lines changed: 0 additions & 9 deletions
This file was deleted.

0 commit comments

Comments
 (0)