Skip to content

Commit

Permalink
updates
Browse files Browse the repository at this point in the history
  • Loading branch information
leo10tt10 committed Aug 28, 2017
1 parent 3f2a27d commit 6707ac1
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 7 deletions.
14 changes: 8 additions & 6 deletions README.md
Expand Up @@ -22,17 +22,19 @@ pip install pysine
or

```
cd DESIRED_SOUCE_CODE_DIRECTORY
cd DESIRED_SOURCE_CODE_DIRECTORY
git clone https://www.github.com/lneuhaus/pysine
python setup.py develop
cd pysine
python setup.py install
```

## Quick start / usage example:

From the command line:
```
python -m pysine frequency duration
python -m pysine 440.0 3
```
A sine sound with the desired properties should be heard.
The sound of a 880-Hz sine wave should be heard for a duration of 3 seconds.

Within a python code block:
```
Expand All @@ -46,10 +48,10 @@ Please report all problems or wishes as new issues on [this page](https://github
## Unit test
Use nosetests for unit tests:
```
cd package_code_directory
cd PACKAGE_SOURCE_CODE_DIRECTORY
nosetests
```
All tests should take about 3 minutes and finish without failures or errors. If there are errors, please report the console output as an issue (see the section "Issues" below for detailed explanations).
If there are errors, please report the console output as an issue (see the section Issues below for detailed explanations) with as much detail on your test environment (operating system, hardware specifics, ...) as possible.

## License
Please read our license file [LICENSE](https://github.com/lneuhaus/pysine/blob/master/LICENSE) for more information.
2 changes: 1 addition & 1 deletion setup.py
Expand Up @@ -67,7 +67,7 @@ def find_packages():

setup(name='pysine',
version=version,
description='Allows to play single tones on the PyAudio sound output in real time',
description='Allows to play single tones on the PyAudio sound output in real time.',
long_description=long_description,
author='Leonhard Neuhaus',
author_email='leonhard.neuhaus@gmail.com',
Expand Down

0 comments on commit 6707ac1

Please sign in to comment.