Skip to content

Commit

Permalink
Fix docs (#1486)
Browse files Browse the repository at this point in the history
  • Loading branch information
yschimke authored Jul 14, 2023
1 parent aaf34de commit d28a63a
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 19 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ A good first step is
$ ./gradlew spotlessApply spotlessCheck compileDebugSources compileReleaseSources metalavaGenerateSignature metalavaGenerateSignatureDebug lintDebug
```

Also make sure you have [Git LFS]([url](https://git-lfs.github.com/)) installed.
Also make sure you have ([Git LFS](https://git-lfs.github.com/)) installed.

If you change any code affecting screenshot tests, then run the following and check the failures in the `out` directory.

Expand Down Expand Up @@ -57,7 +57,7 @@ information on using pull requests.

This project uses a semi-automatic pipeline to translate strings. When new or
updated localized strings are ready, a PR is generated (example:
google/horologist#692). Only the files configured via [localization.bzl](localization.bzl)
google/horologist#692). Only the files configured via [localization.bzl](https://github.com/google/horologist/blob/main/localization.bzl)
are sent for translation.

If you see a problem with translated text, don't edit localized resource files
Expand Down
34 changes: 17 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,16 +14,16 @@ sample app that you can run to see the toolkit in action.

The toolkit includes:

- [horologist-media-ui](./media/ui): common media UI components and screens like `PlayerScreen`.
- [horologist-media](./media/core): domain model for Media related functionality. Provides an
- [horologist-media-ui](https://google.github.io/horologist/media-ui): common media UI components and screens like `PlayerScreen`.
- [horologist-media](https://google.github.io/horologist/media): domain model for Media related functionality. Provides an
abstraction
to the UI module (`horologist-media-ui`) that is agnostic to the Player implementation.
- [horologist-media-data](./media/data): implementation of the domain module (`horologist-media`)
- [horologist-media-data](https://google.github.io/horologist/media-data): implementation of the domain module (`horologist-media`)
using [Media3](https://developer.android.com/jetpack/androidx/releases/media3).
- [horologist-media3-backend](./media/backend-media3): Player on top of Media3 including
- [horologist-media3-backend](https://google.github.io/horologist/media3-backend): Player on top of Media3 including
functionalities
such as avoiding playing music on the watch speaker.
- [media sample](./media/sample): sample app to listen to downloaded music.
- [media sample](https://google.github.io/horologist/media-sample): sample app to listen to downloaded music.

Player Screen | Browse Screen | Entity Screen
:------------:|:-------------:|:-------------:
Expand All @@ -33,7 +33,7 @@ Player Screen | Browse Screen | Entity Screen

High quality prebuilt composables, such as Time and Date pickers.

- [horologist-composables](./composables)
- [horologist-composables](https://google.github.io/horologist/composables)

DatePicker | TimePickerWith12HourClock | TimePicker
:-------------------------:|:-------------------------:|:-------------------------:
Expand All @@ -47,7 +47,7 @@ SegmentedProgressIndicator | SquareSegmentedProgressIndicator

Layout related functionality such as a Navigation Aware Scaffold.

- [horologist-compose-layout](./compose-layout)
- [horologist-compose-layout](https://google.github.io/horologist/compose-layout)

| fillMaxRectangle() |
|:------------------------------------------------------------------------------------------------------------------------------------------:|
Expand All @@ -61,15 +61,15 @@ the [Wear Material Compose library](https://developer.android.com/jetpack/androi
of [Wear Material Design Kit](https://developer.android.com/design/ui/wear/guides/foundations/download)
.

- [horologist-compose-material](./compose-material)
- [horologist-compose-material](https://google.github.io/horologist/compose-material)

## 🔊 Audio and UI

Domain model for Audio related functionality. Volume Control, Output switching.
Subscribing to a Flow of changes in audio or output.

- [horologist-audio](./media/audio)
- [horologist-audio-ui](./media/audio-ui)
- [horologist-audio](https://google.github.io/horologist/audio)
- [horologist-audio-ui](https://google.github.io/horologist/audio-ui)

| VolumeScreen |
|:------------------------------------------------------------------------------------------------------------------------------:|
Expand All @@ -81,24 +81,24 @@ Libraries to help developers to build apps following
the [Sign-In guidelines for Wear OS](https://developer.android.com/training/wearables/design/sign-in)
.

- [horologist-auth-composables](./auth/composables): composable screens for authentication use
- [horologist-auth-composables](https://google.github.io/horologist/auth-composables): composable screens for authentication use
cases, with no dependency on the `auth-data` library.
- [horologist-auth-ui](./auth/ui): composable screens for authentication use cases, with integration
- [horologist-auth-ui](https://google.github.io/horologist/auth-ui): composable screens for authentication use cases, with integration
with the `auth-data` library
- [horologist-auth-data](./auth/data): implementation for Wear apps for most of the authentication
- [horologist-auth-data](https://google.github.io/horologist/auth-data): implementation for Wear apps for most of the authentication
methods listed in
the [Authentication on wearables](https://developer.android.com/training/wearables/apps/auth-wear)
guide.
- [horologist-auth-data-phone](./auth/data-phone): implementation for Mobile apps for some of the
- [horologist-auth-data-phone](https://google.github.io/horologist/auth-data-phone): implementation for Mobile apps for some of the
authentication methods provided by the `auth-data` library.
- [sample wear](./auth/sample/wear): sample wear app to authenticate using different methods.
- [sample phone](./auth/sample/phone): sample phone app to authenticate using different methods.
- [sample wear](https://google.github.io/horologist/auth-sample-apps/#wear-sample): sample wear app to authenticate using different methods.
- [sample phone](https://google.github.io/horologist/auth-sample-apps/#phone-sample): sample phone app to authenticate using different methods.

## ☰ Tiles

Kotlin coroutines flavoured TileService.

[horologist-tiles](./tiles)
[horologist-tiles](https://google.github.io/horologist/tiles)

---

Expand Down

0 comments on commit d28a63a

Please sign in to comment.