Merge pull request #59 from MultiBuds/clarify-readme-osi

Clarify README regarding open-source license
This commit is contained in:
Ben V. Brown 2023-06-27 09:11:08 +10:00 committed by GitHub
commit 26ed719d5d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 1 deletions

View File

@ -1,8 +1,10 @@
# PineBuds Open Source SDK # PineBuds SDK
This is just the SDK from the wiki (so far), with dockerfile setup to make building easier, and my reverse engineered bestool integrated. This is just the SDK from the wiki (so far), with dockerfile setup to make building easier, and my reverse engineered bestool integrated.
The docker image will build bestool for you first, then drop you into the dev container for building and flashing the buds. The docker image will build bestool for you first, then drop you into the dev container for building and flashing the buds.
NOTE: Currently, the SDK is not licensed under an 'open source' license. We are working to resolve this issue, and will be reaching out to contributors and other parties soon. For now, consider this SDK as 'All Rights Reserved'/'shared source'.
## Usage ## Usage
To use this setup to build & flash your PineBuds you will need a system with docker setup at the minimum. To use this setup to build & flash your PineBuds you will need a system with docker setup at the minimum.