Skip to content

Commit

Permalink
contributing
Browse files Browse the repository at this point in the history
  • Loading branch information
FlorianAtNacamar committed Mar 9, 2021
1 parent dafb4f2 commit 1e4d1fa
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 0 deletions.
12 changes: 12 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# How to contribute?
First of all. Thank you for considering to contribute to this project.

## Issues
You are welcome to state your wishes in terms of [isssues](https://github.com/ybrid/opus-swift/issues) in this project. Of course reporting of bugs is favored in this transparent way, too.

## Tests
We do not own all exisiting ios device types of the past and the future. So try running the script ```test.sh``` with your device configured in the script. Tell us about success or failure. Does the test script pass the tests on your mac? This will help us improve the power of this software.

## Tell us your needs
### package management
Currently we support integration with CocoaPods. You may tell us which type of package management you use.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,5 +30,8 @@ If you manage packages in another way you may download YbridOpus.xcframework.zip

Unzip the file into a directory called 'Frameworks' of your XCode project. In the properties editor, drag and drop the directory into the section 'Frameworks, Libraries and Embedded Content' of the target's 'General' tab.

# Contributing
You are welcome to [contribute](https://github.com/ybrid/opus-swift/blob/master/CONTRIBUTING.md).

# Licenses
This project is under MIT license. We create the opus binaries for iOS and macOS from [opus sources of version 1.3.1](https://opus-codec.org/release/stable/2019/04/12/libopus-1_3_1.html). Opus is freely licensed under BSD, see the [LICENSE](https://github.com/ybrid/opus-swift/blob/master/LICENSE) file.

0 comments on commit 1e4d1fa

Please sign in to comment.