-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
14 additions
and
62 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,73 +1,25 @@ | ||
| # Nordic Common Libraries for Android | ||
| A libraries with Nordic's common code for Android apps. | ||
|
|
||
| ## Theme | ||
|
|
||
| ### Usage | ||
| ```groovy | ||
| implementation 'no.nordicsemi.android.common:theme:<version>' | ||
| ``` | ||
|
|
||
| ### Content | ||
| The library contains a few features which are necessary for theming Nordic Semiconductor apps: | ||
|
|
||
| * Color palette adopted to the new Material You | ||
| * Typography | ||
| * Nordic theme for dark and light mode | ||
| * Abstract `NordicActivity` class which contain implementations for Nordic's splash screen animation. | ||
| * `WizardStepComponent` for wizard-based app flow. | ||
| * `CircularIcon` an icon with circular shape. | ||
| * Other common views available for different projects. | ||
|
|
||
| ## Permission | ||
|
|
||
| ### Usage | ||
| ```groovy | ||
| implementation 'no.nordicsemi.android.common:permission:<version>' | ||
| ``` | ||
|
|
||
| ### Content | ||
| Classes and views related to managing permissions, including Bluetooth and Internet permissions. | ||
|
|
||
| ## Navigation | ||
|
|
||
| ### Usage | ||
| ```groovy | ||
| implementation 'no.nordicsemi.android.common:navigation:<version>' | ||
| ``` | ||
|
|
||
| ### Content | ||
| Common navigation components for the app. | ||
|
|
||
| ## UI Scanner | ||
|
|
||
| ### Usage | ||
| ```groovy | ||
| implementation 'no.nordicsemi.android.common:uiscanner:<version>' | ||
| ``` | ||
| A libraries with Nordic's common code for Android apps. | ||
|
|
||
| ### Content | ||
| Common Bluetooth LE scanner screen. | ||
| ## Documentation | ||
|
|
||
| ## UI Logger | ||
| The latest documentation can be found [here](https://nordicplayground.github.io/KAndroid-Common-Libraries/html/index.html). | ||
|
|
||
| ### Usage | ||
| ```groovy | ||
| implementation 'no.nordicsemi.android.common:uilogger:<version>' | ||
| ``` | ||
| ## Usage | ||
|
|
||
| ### Content | ||
| Common classes related with logging to nRF Logger app. | ||
| To use this library, add the following to your `build.gradle` file: | ||
|
|
||
| ## Analytics | ||
|
|
||
| ### Usage | ||
| ```groovy | ||
| implementation 'no.nordicsemi.android.common:analytics:<version>' | ||
| ```gradle | ||
| dependencies { | ||
| implementation 'no.nordicsemi.android.common:<module>:<version>' | ||
| } | ||
| ``` | ||
|
|
||
| ### Content | ||
| Common views and classes related with gathering analytics data. | ||
|
|
||
| ## Sample app | ||
|
|
||
| Run the sample app to see and test most of the components from the library. | ||
|
|
||
| 1. Clone the repository. | ||
| 2. Open the project in Android Studio. | ||
| 3. Run the `app` module on a connected device or emulator. |