Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
PyrApple committed Mar 27, 2017
1 parent e7c20cb commit d7f8462
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,15 @@

Load a Sofa formatted HRTFs set from either a local or distant server. Instant access to closest match HRTF IRs {left,right} as an [AudioBuffer](https://developer.mozilla.org/fr/docs/Web/API/AudioBuffer) object for any given position. First published as a subclass of the [binauralFIR] library.

This library provides an access to a server, in order to load a set of
Head-related transfer functions ([HRTF]).

This library is compatible with the [Web Audio API]. The novelty of this
library is that it permits to use a custom [HRTF] dataset (see
[T. Carpentier article]).
## How to use ##

See [binauralFIR] for an example use-case.
Add the library to your node project:
```bash
npm install Ircam-RnD/serveSofaHrir
```

and check the ``./examples`` folder for implementation details. See [binauralFIR] for an example use-case.

## Documentation ##

Expand Down

0 comments on commit d7f8462

Please sign in to comment.