Mercury/openshock-android
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

readme.md

Browse source
This commit is contained in:
Mercurio 2023-11-09 18:26:17 +01:00 committed by GitHub
parent 061ccc0776
commit 66fb8461e5
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 24 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
README.md
View file

@ -1,2 +1,25 @@
# 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
```