README.md

mrumru

Dart package for the Data Over Audio protocol

Installation

Use git clone to download mrumru project

git clone [email protected]:snggle/mrumru.git

Usage

The project runs on flutter version 3.16.9. You can use fvm for easy switching between versions otherwise see flutter installation

# Install and use required flutter version
fvm install 3.16.9
fvm use 3.16.9

# Install required packages in pubspec.yaml
fvm flutter pub get

# Run project
cd example
fvm flutter run lib/main.dart

To generate config files use

fvm flutter pub run build_runner

# Built-in Commands 
# - build: Runs a single build and exits.
# - watch: Runs a persistent build server that watches the files system for edits and does rebuilds as necessary
# - serve: Same as watch, but runs a development server as well

# Command Line Options
# --delete-conflicting-outputs: Assume conflicting outputs in the users package are from previous builds, and skip the user prompt that would usually be provided.
# 
# Command example:

fvm flutter pub run build_runner watch --delete-conflicting-outputs

Tests

To run tests

# Run package unit tests
fvm flutter test test/unit --null-assertions

# Run the unit tests from the package example
fvm flutter test example/test/unit --null-assertions

# Run specific test
fvm flutter test path/to/test.dart --null-assertions

Contributing

Pull requests are welcomed. For major changes, please open an issue first, to enable a discussion on what you would like to improve. Please make sure to provide and update tests as well.

Licence