diff --git a/README.md b/README.md index 7ddb10d2..1ad4d291 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,23 @@ -# OpenWearable - App +# OpenWearables - App -The OpenWearable App is a mobile application for connecting to, configuring, and interacting with wearable devices. It is designed as a flexible companion app for research, development, and prototyping with sensor-rich wearable platforms. +The OpenWearables App is a mobile application for connecting to, configuring, and interacting with wearable devices. It is designed as a flexible companion app for research, development, and prototyping with sensor-rich wearable platforms. -The app supports live sensor control, data visualizations and example applications that demonstrate how wearable devices can be used in practice. [OpenEarable](https://openearable.com) is one example of a compatible OpenWearable device. It is a fully open-source platform for ear-based sensing applications with true wireless audio, high-precision sensors, and a modular, reconfigurable hardware design. +The app supports live sensor control, data visualizations and example applications that demonstrate how wearable devices can be used in practice. [OpenEarable](https://openearable.com) is one example of a compatible OpenWearables device. It is a fully open-source platform for ear-based sensing applications with true wireless audio, high-precision sensors, and a modular, reconfigurable hardware design. -For more information about the OpenWearable ecosystem, visit [openwearables.com](https://openwearables.com). +For more information about the OpenWearables ecosystem, visit [openwearables.com](https://openwearables.com). + +## Project Structure + +This repository is primarily the Flutter app in [`open_wearable/`](./open_wearable/). + +High-level architecture and state-management docs live in [`open_wearable/docs/`](./open_wearable/docs/README.md). + +- [App Setup and Architecture](./open_wearable/docs/app-setup.md) +- [State and Providers](./open_wearable/docs/state-and-providers.md) ## Features -- Connect to compatible OpenWearable devices, such as OpenEarable +- Connect to compatible devices from OpenWearables, such as OpenEarable - Configure available device sensors - Control audio features - Show live data from wearable sensors @@ -18,11 +27,37 @@ For more information about the OpenWearable ecosystem, visit [openwearables.com] ## Getting Started -To get started with the OpenWearable App, you need: +To get started with the OpenWearables App, you need: -- A compatible OpenWearable device, such as an OpenEarable device with the latest firmware +- A compatible OpenWearables device, such as an OpenEarable device with the latest firmware - A working Flutter installation +## Development Quick Start + +1. Install Flutter on the stable channel. +2. From the app module, fetch dependencies: + + ```bash + cd open_wearable + flutter pub get + ``` + +3. Run on a connected device or emulator: + + ```bash + cd open_wearable + flutter run + ``` + +To enter demo mode with simulated sensor values, start the app with the App Store preview flag: + +```bash +cd open_wearable +flutter run --dart-define=APP_STORE_PREVIEW=true +``` + +This launches the preview shell used for screenshots and demo flows instead of the normal Bluetooth-connected app. + ## Contributing Contributor expectations and workflow rules are documented in [CONTRIBUTING.md](./CONTRIBUTING.md). @@ -32,7 +67,7 @@ Contributor expectations and workflow rules are documented in [CONTRIBUTING.md]( 1. Clone this repository: ```bash - git clone https://github.com/OpenWearable/app.git + git clone https://github.com/OpenEarable/app.git ``` 2. Navigate to the project folder in your terminal. @@ -42,6 +77,7 @@ Contributor expectations and workflow rules are documented in [CONTRIBUTING.md]( 4. Start the app on your phone: ```bash + cd open_wearable flutter run ``` @@ -56,7 +92,14 @@ Contributor expectations and workflow rules are documented in [CONTRIBUTING.md]( 3. Run the app in release mode: ```bash + cd open_wearable flutter run --release ``` Select your phone as the target device from the list of connected devices. + +## Notes + +- Core app bootstrap is in [`open_wearable/lib/main.dart`](./open_wearable/lib/main.dart). +- Route definitions are in [`open_wearable/lib/router.dart`](./open_wearable/lib/router.dart). +- High-level feature state is primarily under [`open_wearable/lib/view_models/`](./open_wearable/lib/view_models/). diff --git a/open_wearable/README.md b/open_wearable/README.md index 653509be..1d680385 100644 --- a/open_wearable/README.md +++ b/open_wearable/README.md @@ -1,28 +1,5 @@ -# OpenWearable App Module +# OpenWearables App Module -Flutter application module for the OpenEarable app. +This folder contains the main Flutter app for the repository. -## Documentation - -High-level architecture and state-management docs live in [`docs/`](./docs/README.md). - -- [App Setup and Architecture](./docs/app-setup.md) -- [State and Providers](./docs/state-and-providers.md) - -## Development Quick Start - -1. Install Flutter (stable channel). -2. From this folder (`open_wearable/`), fetch dependencies: - ```bash - flutter pub get - ``` -3. Run on a connected device/emulator: - ```bash - flutter run - ``` - -## Notes - -- Core app bootstrap is in `lib/main.dart`. -- Route definitions are in `lib/router.dart`. -- High-level feature state is primarily under `lib/view_models/`. +For the primary project overview, setup instructions, and documentation links, see the [root README](../README.md). diff --git a/open_wearable/android/app/src/main/AndroidManifest.xml b/open_wearable/android/app/src/main/AndroidManifest.xml index eb49e63d..800532f0 100644 --- a/open_wearable/android/app/src/main/AndroidManifest.xml +++ b/open_wearable/android/app/src/main/AndroidManifest.xml @@ -1,5 +1,5 @@ - + - + - OpenWearable | App + OpenWearables | App