Skip to content

Commit 3d48e66

Browse files
committed
Readme update
1 parent 6ad64f4 commit 3d48e66

1 file changed

Lines changed: 38 additions & 30 deletions

File tree

README.md

Lines changed: 38 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
1-
# Vega TV Interfaces Sample App
1+
Vega TV Interfaces Sample App
2+
=============================
23

34
The Vega TV Interfaces Sample App is built with the Vega Developer Tools. This sample app demonstrates the recommended approaches for building TV-focused interfaces with React Native.
45

56
![App Preview](./docs/images/launch-app.png)
67

7-
## Introduction
8+
Introduction
9+
------------
810

911
The TV Interfaces Example demonstrates how to build performant and user-friendly TV applications. This feature-focused sample app serves as a practical guide for developers implementing TV-optimized layouts and components.
1012

@@ -33,7 +35,8 @@ TV applications are navigated primarily with directional controls (up, down, lef
3335

3436
The examples in this document demonstrate proven patterns that create intuitive, responsive TV experiences using the Vega Developer Tools.
3537

36-
## Documentation Overview
38+
Documentation Overview
39+
----------------------
3740

3841
This sample app's documentation is organized into the following sections:
3942

@@ -50,18 +53,19 @@ Detailed Component and Hook Documentation:
5053
* [Hooks](./docs/hooks.md) - Collection of custom hooks for TV interface development.
5154

5255

53-
## Build and run the app
56+
Build and run the app
57+
---------------------
5458

5559
### Prerequisites
5660

57-
Before you launch the sample app, make sure that you have [installed the Vega Developer Tools](https://developer.amazon.com/docs/vega/0.21/install-vega-sdk.html) and NodeJS 18-20.
61+
Before you launch the sample app, make sure that you have [installed the Vega Developer Tools](https://developer.amazon.com/docs/vega/latest/install-vega-sdk.html) and NodeJS 18-20.
5862

5963

6064
### Step 1: Build the app
6165

6266
After you download the source code from GitHub, you can build the Vega TV Interfaces Sample App from the command line to generate VPKG files. The VPKG files run on the Vega Virtual Device and Vega OS Fire TV Stick.
6367

64-
You can also use [Vega Studio](https://developer.amazon.com/docs/vega/0.21/setup-extension.html#learn-the-basic-features) with Visual Studio Code to build the app.
68+
You can also use [Vega Studio](https://developer.amazon.com/docs/vega/latest/setup-extension.html#learn-the-basic-features) with Visual Studio Code to build the app.
6569

6670
1. At the command prompt, navigate to the Vega TV Interfaces Sample App source code directory.
6771

@@ -90,7 +94,7 @@ You can also use [Vega Studio](https://developer.amazon.com/docs/vega/0.21/setup
9094
1. To start the Vega Virtual Device, at the command prompt, run the following command.
9195

9296
```
93-
kepler virtual-device start
97+
vega virtual-device start
9498
```
9599

96100
2. Go to the directory where you placed the VPKG files.
@@ -100,13 +104,13 @@ You can also use [Vega Studio](https://developer.amazon.com/docs/vega/0.21/setup
100104
- On Mac M-series based devices.
101105

102106
```
103-
kepler run-kepler build/aarch64-release/keplertvinterfaces_aarch64.vpkg
107+
vega run-app build/aarch64-release/keplertvinterfaces_aarch64.vpkg
104108
```
105109
106110
- On x86_64 based devices.
107111
108112
```
109-
kepler run-kepler build/x86_64-release/keplertvinterfaces_x86_64.vpkg
113+
vega run-app build/x86_64-release/keplertvinterfaces_x86_64.vpkg
110114
```
111115
112116
#### Vega OS Fire TV Stick
@@ -116,14 +120,15 @@ You can also use [Vega Studio](https://developer.amazon.com/docs/vega/0.21/setup
116120
2. To install and launch the app on your Vega OS Fire TV Stick, run the following command.
117121
118122
```
119-
kepler run-kepler build/armv7-release/keplertvinterfaces_armv7.vpkg
123+
vega run-app build/armv7-release/keplertvinterfaces_armv7.vpkg
120124
```
121125
122126
123127
124128
125129
126-
## Troubleshooting the app
130+
Troubleshooting the app
131+
-----------------------
127132
128133
If you're facing unexpected issues while trying to build and run the app (For example, the build is failing randomly, the app is not starting, or the app is crashing randomly.) try the following solutions:
129134
@@ -146,11 +151,12 @@ npm start -- --reset-cache
146151
147152
* Restart the simulator. We have observed the simulator crashing randomly if it's used without restarting for extended periods of time.
148153
149-
* Run the `kepler clean` command. This removes the artifacts generated in the top level `/.build` folder. To learn more, see the [Vega CLI Functions](https://developer.amazon.com/docs/vega/0.21/cli-tools.html) document.
154+
* Run the `vega clean` command. This removes the artifacts generated in the top level `/.build` folder. To learn more, see the [Vega CLI Functions](https://developer.amazon.com/docs/vega/latest/cli-tools.html) document.
150155
151156
152157
153-
## Testing the app
158+
Testing the app
159+
---------------
154160
155161
[React Native Testing Library (RNTL)](https://callstack.github.io/react-native-testing-library/) is used for component and integration testing in this project. RNTL provides a robust set of tools for testing React Native apps with a focus on user interactions and accessibility.
156162
@@ -174,29 +180,27 @@ npm run test:watch
174180
175181
For more detailed information about our testing setup, best practices, and custom utilities, please refer to the [testing documentation](./src/test-utils/README.md) in the test-utils directory.
176182
177-
## Services
183+
Services
184+
--------
178185
179186
The app is structured to delegate specific tasks to encapsulated units of logic known as services. Each service is designed to handle a particular functionality, allowing for clean separation of concerns and ensuring that the logic is reusable and maintainable. This approach allows services to be potentially extracted and used in other applications with ease.
180187
181-
- [**AppConfig Service**](./src/services/appConfig/README.md): Manages environment variables defined in the `.env` file, enabling the app to read and apply configuration settings.
188+
- [**AppConfig Service**](src/services/appConfig/README.md): Manages environment variables defined in the `.env` file, enabling the app to read and apply configuration settings.
182189
183-
- [**ApiClient Service**](./src/services/apiClient/README.md): Manages fetching data from various data sources exposing a common API for different clients that can be consumed across the app especially in fetchers implemented in `src/api` folder.
190+
- [**DeviceInfo Service**](src/services/deviceInfo/README.md): Provides access to device-specific information, such as determining the type of device, and interacts with device-related APIs.
184191
185-
- [**DeviceInfo Service**](./src/services/deviceInfo/README.md): Provides access to device-specific information, such as determining the type of device, and interacts with device-related APIs.
192+
- [**DeviceStorage Service**](src/services/Storage/README.md): Provides access to device storage, by abstracting storage-related APIs exposed by `AsyncStorage`.
186193
187-
- [**DeviceStorage Service**](./src/services/deviceStorage/README.md): Provides access to device storage, by abstracting storage-related APIs exposed by `AsyncStorage`.
194+
- [**NetInfo Service**](src/services/netInfo/README.md): Monitors internet connectivity, manages the network state, and listens for network-related events.
188195
189-
- [**NetInfo Service**](./src/services/netInfo/README.md): Monitors internet connectivity, manages the network state, and listens for network-related events.
196+
- [**i18n Service**](src/services/i18n/README.md): Provides methods to manage translations in the app.
190197
191-
- [**Auth Service**](./src/services/auth/README.md): Manages user authentication, including signing users in and out, and restoring session data from device storage.
198+
- [**Focus Guide Service**](src/services/focusGuide/README.md): Provides hooks and wrappers to manage focusing elements in the app.
192199
193-
- [**i18n Service**](./src/services/i18n/README.md): Provides methods to manage translations in the app.
200+
- [**Accessibility (a11y) Service**](src/services/a11y/README.md): Provides common logic for applying complex accessibility properties to components.
194201
195-
- [**Focus Guide Service**](./src/services/focusGuide/README.md): Provides hooks and wrappers to manage focusing elements in the app.
196-
197-
- [**Accessibility (a11y) Service**](./src/services/a11y/README.md): Provides common logic for applying complex accessibility properties to components.
198-
199-
## Customize the UI theme
202+
Customize the UI theme
203+
----------------------
200204
201205
You can customize the UI by changing the color scheme and font settings.
202206
@@ -322,7 +326,8 @@ src/theme/
322326

323327
New tokens are visible after you reload your app.
324328

325-
## Components
329+
Components
330+
----------
326331

327332
To provide default props and customize components, importing directly from `@amazon-devices/kepler-ui-components` is blocked across the app.
328333

@@ -408,7 +413,8 @@ const styles = useThemedStyles(({colors}: AppTheme) => StyleSheet.create({
408413
* **`StyleSheet.NamedStyles`**: A type from React Native's `StyleSheet` API for defining strongly-typed styles.
409414

410415

411-
## Set up translations
416+
Set up translations
417+
-------------------
412418

413419
This section describes how to adjust existing translations to your needs and includes detailed information about the i18n service.
414420

@@ -560,13 +566,15 @@ To keep all translation files with the same shape, we provide a script to sync t
560566
```
561567
npm run i18n:sync
562568
```
563-
## Release Notes
569+
Release Notes
570+
-------------
564571

565572
- v0.21
566573

567574
Initial release.
568575

569-
## License
576+
License
577+
-------
570578

571579
This project is licensed under the MIT-0 License - see the [LICENSE](LICENSE) file for details.
572580

0 commit comments

Comments
 (0)