Commit 90bf6d21 authored by Paul Bethge's avatar Paul Bethge
Browse files

edit README

parent 9221fa0a
Project Name
High-Level Audio Processing in Python
============
_Project overview image here, if possible_
_Short, one to two line project description._
This project contains code for live audio recording and processing in python.
Besides basic usage of Pyaudio for simple recording, you will find asynchronous
processing methods and the use of artificial intelligence for high level applications.
This code has been developed by [ZKM | Hertz-Lab](https://zkm.de/en/about-the-zkm/organization/hertz-lab) as part of the project [»The Intelligent Museum«](#the-intelligent-museum).
Copyright (c) 2021 ZKM | Karlsruhe.
Copyright (c) 2021 Artist Developer.
Copyright (c) 2021 Paul Bethge.
For information on usage and redistribution, and for a DISCLAIMER OF ALL
WARRANTIES, see the file, "LICENSE.txt," in this distribution.
......@@ -18,74 +18,17 @@ BSD Simplified License.
Description
-----------
_Detailed project description. Don't forget to include relevant attribution for forked, adapted, or inspired projects._
### Structure
_List repo folder structure for larger, more complicated projects_
* folder1/: contains models
* folder2/: contains media assets
* etc...
Requirements
------------
(Software) dependencies:
* libA
* libB
* etc...
Operating systems/platforms:
* macOS
* Linux
* Windows
* etc...
_Add any notes about which platforms or setups were used for development & testing._
Installation & Build
--------------------
_General dependency & build install instructions with per-platform subsections when needed. Please include commandline steps, when applicable._
Right now, this project only contains example code for quick and dirty sound processing.
We may use class abstraction at some point in time.
You will find a lot of borrowed code and trained neural nets from other repository, instead of submodules, as the purpose of this project is to maintain working code rather than bleeding edge technology.
Download and Install [Anaconda](https://www.anaconda.com/products/individual). Afterwards create a virtual environment:
```shell
$ conda create -n "name" python=3.7
$ conda activate "name"
$ pip install -r requirements.txt
```
We want to thank the following repositories for providing open-source solutions:
- silero-vad
- speech-commands
Usage
-----
_Usage instructions for when the application is built and installed._
#### Show Help
```
$ python executable.py --help
```
#### scenario 1
```
$ python executable.py --parameter 42
```
References / Further Reading
----------------------------
_List useful references, related projects, or papers here._
* [paper](www.google.com)
* [paper2](www.google.com)
Contribute
----------
Contributions are very welcome! Clone or fork the repo, then request a pull / merge.
If you find any bugs or suggestions please log them here as well.
--------------
Please find a README in each of the example subfolders for clarification of the requirements and usage as each example is very different in that regard.
The Intelligent Museum
----------------------
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment