Module name and readme

[Richardjmorton]

Hi,

I now know a few who have struggled with starting to use this package. I just wanted to make a couple of suggestions that would help with basic issues.

First, the module when downloaded is stored in the folder named 'image-noise-gate'. If using a single location for python modules (that is scanned for existing modules, e.g. by it being in your PYTHON_PATH), then this folder name cannot be imported as a module, i.e. from image-noise-gate.noisegate import noise_gate_batch does not work. This is due to the hyphens. So I would change this to underscores.

Second, those not familiar with Cython (like myself) struggle to get started. I would add a couple of lines more to the readme that discuss building the module, and maybe an example import statement. Happy to add these myself and make a pull request.

[ebuchlin]

More detailed instructions would indeed be useful. Here is what I have done (Ubuntu):

• Install the cython3 system package
• Run python setup.py install --user
• Import by from noisegate.tools import noise_gate_batch. Just import noisegate does not import anything, this seems to be because the__init__.py is not copied by setup.py to the installation directory