Skip to content

Commit

Permalink
Chore: Update license, workflow & readme (#3)
Browse files Browse the repository at this point in the history
  • Loading branch information
Sese-Schneider authored Jan 29, 2024
1 parent c0b058b commit 2ca8287
Show file tree
Hide file tree
Showing 3 changed files with 37 additions and 15 deletions.
27 changes: 27 additions & 0 deletions .github/workflows/flutter.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
name: Flutter

on:
push:
branches: ["main", "develop"]
pull_request:
branches: ["main", "develop"]
workflow_dispatch:

jobs:
lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3

- uses: subosito/flutter-action@v2
with:
channel: "stable"

- name: Install dependencies
run: flutter pub get

- name: Verify formatting
run: dart format --output=none --set-exit-if-changed .

- name: Analyze project source
run: dart analyze --fatal-infos
7 changes: 1 addition & 6 deletions LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,4 @@ ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


Parts of this project are using the library http://www.libdivecomputer.org/
libdivecomputer Copyright (c) 2008 Jef Driesen
The library is licensed under the GNU Lesser General Public License version 2.1.
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,7 @@ A Flutter plugin for communication with dive computers using the library [libdiv

## Installation

### Android, Windows, Linux

The required library is automatically bundled with the plugin.
No further installation steps are required.

### iOS, MacOS

The required library needs to be linked with with your Runner.
Please follow the instructions for linking a [compiled (dynamic) library](https://docs.flutter.dev/platform-integration/macos/c-interop#compiled-dynamic-library-macos).
TODO


## Usage
Expand All @@ -25,7 +17,15 @@ This plugin automatically spawns its own isolate for communication with the dive

Please refer to the example app for a minimalistic example usage.

---

### Acknowledgements

Parts of this project are using the library [libdivecomputer](https://www.libdivecomputer.org/).

> libdivecomputer Copyright (c) 2008 Jef Driesen
<sup>The library is licensed under the GNU Lesser General Public License version 2.1.</sup>

[license]: https://img.shields.io/github/license/DiveNote/dive_computer.svg?style=for-the-badge
[release]: https://img.shields.io/pub/v/dive_computer?style=for-the-badge
Expand Down

0 comments on commit 2ca8287

Please sign in to comment.