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

Update README.md

Browse source
This commit is contained in:
Mercurio 2023-11-13 20:06:16 +01:00 committed by GitHub
parent 1668b784e9
commit 514b823e6a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 22 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

35
README.md
View file

@ -1,34 +1,43 @@
# openshock-android
> Companion app for managing openshock-compatible devices
>
> Minimum supported Android API: 31 (Android 12).
>
![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.
Flutter application to manage and control openshock devices from your phone
Current build status: [![Flutter Build](https://github.com/NotLugozzi/openshock-android/actions/workflows/main.yml/badge.svg)](https://github.com/NotLugozzi/openshock-android/actions/workflows/main.yml)
Current build status: [![Flutter Build](https://github.com/NotLugozzi/openshock-android/actions/workflows/main.yml/badge.svg)](https://github.com/NotLugozzi/openshock-android/actions/workflows/main.yml)
# Installing
## Stable release channel
### **Release builds are currently broken! if you know how to flutter shoot me a dm on discord @olbiaphlee, we can get in touch to get it to work!**
Grab one of the builds from the releases page or run:
```bash
flutter build apk
```
Production artifacts will be found in the `build\app\outputs\apk\` directory.
production artifacts will be found in the `build\app\outputs\apk\` directory
## RRC (Rolling Release Channel)
There's also a Rolling release available as a GitHub Actions artifact. It runs every time I commit, so it might be up to date but also potentially broken.
## RRC
There's also a Rolling release available as a github action artifact. it runs every time i commit so it might be up to date but also really, really broken
# Building for Android
Make sure you have [Flutter](https://flutter.dev/), [Android Studio](https://developer.android.com/studio), and [Visual Studio Code](https://code.visualstudio.com/) installed. Install the suggested Flutter, Dart, and linting extensions in Visual Studio Code.
# 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
Run the following commands to ensure all dependencies are met:
```bash
flutter doctor
```
`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 won't be saved when building for android unless running the build command
You'll be guided through a first-time setup that checks for platform tools, dependencies, and missing components.
Once the setup is complete you can navigate to the repo folder and run
```bash
flutter run
```
If you want to build debug you can also run
```bash
flutter build apk --debug
```
Build artifacts for Android are saved under `build\app\outputs\apk` regardless of the build type.