Skip to content

Commit

Permalink
add license and readme
Browse files Browse the repository at this point in the history
  • Loading branch information
leng-yue committed Aug 24, 2024
1 parent 76641da commit 789da58
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 3 deletions.
7 changes: 7 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Copyright 2024, Fish Audio

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
23 changes: 20 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,26 @@
# opusenc
# OPUSENC

For any system <= Ubuntu 22.04, you need to install libopusenc-dev manually, run `install_opus.sh`
## Requirements
- libopus-dev
- libopusfile-dev
- libopusenc-dev

For Ubuntu 24.04, you can install libopusenc-dev via apt:
### Ubuntu ≤ 22.04
```bash
sudo apt install libopus-dev libopusfile-dev
bash install_opus.sh # install libopusenc-dev
```

### Ubuntu 24.04

```bash
sudo apt install libopus-dev libopusfile-dev libopusenc-dev
```

## Installation
```bash
pip install git+https://github.com/fishaudio/opusenc.git
```

## Usage
Check `tests/test.py` for more details.
1 change: 1 addition & 0 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,5 @@
cmdclass={"build_ext": build_ext},
zip_safe=False,
python_requires=">=3.7",
license="MIT",
)

0 comments on commit 789da58

Please sign in to comment.