readme.md
This commit is contained in:
parent
061ccc0776
commit
66fb8461e5
25
README.md
25
README.md
|
@ -1,2 +1,25 @@
|
||||||
# openshock-android
|
# openshock-android
|
||||||
Companion app for managing openshock-compatible devices
|
> Companion app for managing openshock-compatible devices
|
||||||
|
>
|
||||||
|
>
|
||||||
|
![lang](https://img.shields.io/badge/Flutter-02569B?style=for-the-badge&logo=flutter&logoColor=white) ![os1](https://img.shields.io/badge/Android-3DDC84?style=for-the-badge&logo=android&logoColor=white)
|
||||||
|
|
||||||
|
Flutter application to manage and control openshock devices from your phone
|
||||||
|
|
||||||
|
# Testing
|
||||||
|
Get both [flutter](https://flutter.dev/) and [android studio](https://developer.android.com/studio), make sure to be able to reach flutter from any terminal by running
|
||||||
|
|
||||||
|
`flutter --version`
|
||||||
|
|
||||||
|
then cd in the repository folder and run the following commands. You'll be greeted by a first time setup that will check for platform tools, dependencies and possible missing stuff. build artifacts will be in the "android" subfolder inside the repo
|
||||||
|
|
||||||
|
```bash
|
||||||
|
flutter run
|
||||||
|
```
|
||||||
|
|
||||||
|
# Installing
|
||||||
|
|
||||||
|
Grab one of the releases from the releases page or run. production artifacts will be found in the android directory
|
||||||
|
```bash
|
||||||
|
flutter build
|
||||||
|
```
|
||||||
|
|
Loading…
Reference in a new issue