Skip to content

Commit dcf111d

Browse files
committed
DOC: README update
1 parent 66dc41c commit dcf111d

File tree

1 file changed

+13
-17
lines changed

1 file changed

+13
-17
lines changed

README.rst

+13-17
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,25 @@
1-
Sound Field Synthesis Toolbox for Python
2-
========================================
1+
Sound Field Synthesis (SFS) Toolbox for Python
2+
==============================================
33

4-
The Sound Field Synthesis Toolbox for Python gives you the possibility to create
5-
numercial simulations of sound field synthesis methods like wave field synthesis
6-
(WFS) or near-field compensated higher order Ambisonics (NFC-HOA).
7-
8-
Theory:
9-
http://sfstoolbox.org/
4+
A Python library for creating numercial simulations of sound field synthesis
5+
methods like Wave Field Synthesis (WFS) or Near-Field Compensated Higher Order
6+
Ambisonics (NFC-HOA).
107

118
Documentation:
12-
http://python.sfstoolbox.org/
9+
https://sfs-python.readthedocs.io/
1310

1411
Source code and issue tracker:
1512
https://github.com/sfstoolbox/sfs-python/
1613

17-
Python Package Index:
18-
https://pypi.python.org/pypi/sfs/
19-
20-
SFS Toolbox for Matlab:
21-
http://matlab.sfstoolbox.org/
22-
2314
License:
2415
MIT -- see the file ``LICENSE`` for details.
2516

2617
Quick start:
27-
* Install NumPy, SciPy and Matplotlib
18+
* Install Python 3, NumPy, SciPy and Matplotlib
2819
* ``python3 -m pip install sfs --user``
29-
* ``python3 doc/examples/horizontal_plane_arrays.py``
20+
* Check out the examples in the documentation
21+
22+
More information about the underlying theory can be found at
23+
https://sfs.readthedocs.io/.
24+
There is also a Sound Field Synthesis Toolbox for Octave/Matlab, see
25+
https://sfs-matlab.readthedocs.io/.

0 commit comments

Comments
 (0)