Skip to content

Commit

Permalink
chore: add installation guide to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
almoghamdani committed Dec 16, 2019
1 parent 8d4ae33 commit 2e1d96b
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,21 @@ Audify.js - Play/Stream/Record PCM audio data & Encode/Decode Opus to PCM au
* Decode Opus packets to 16-bit integer PCM or floating point PCM using C++ Opus library.
* Complete API for realtime audio input/output across Linux (native ALSA, JACK, PulseAudio and OSS), Macintosh OS X (CoreAudio and JACK), and Windows (DirectSound, ASIO and WASAPI) operating systems using C++ RtAudio library.

## Installation
```
npm install audify
```

#### Requirements
* Node versions that support N-API 4 and up ([N-API Node Version Matrix](https://nodejs.org/docs/latest/api/n-api.html#n_api_n_api_version_matrix))
* [CMake](http://www.cmake.org/download/)
* A proper C/C++ compiler toolchain of the given platform
* **Windows**:
* [Visual C++ Build Tools](https://visualstudio.microsoft.com/visual-cpp-build-tools/) or a recent version of Visual C++ will do ([the free Community](https://www.visualstudio.com/products/visual-studio-community-vs) version works well)
* **Unix/Posix**:
* Clang or GCC
* Ninja or Make (Ninja will be picked if both present)

## Example
#### Opus Encode & Decode
```javascript
Expand Down

0 comments on commit 2e1d96b

Please sign in to comment.