From 7c87f33b2a41c0856063766f437764ffeb0571be Mon Sep 17 00:00:00 2001 From: Edouard DUPIN Date: Mon, 16 Mar 2015 22:07:42 +0100 Subject: [PATCH] [DEV] Add readme and licence --- README.md | 59 +++++++++++++++++++++++++++++++++++++++++++++++++++++ license.txt | 13 ++++++++++++ 2 files changed, 72 insertions(+) create mode 100644 README.md create mode 100644 license.txt diff --git a/README.md b/README.md new file mode 100644 index 0000000..1842bff --- /dev/null +++ b/README.md @@ -0,0 +1,59 @@ +audio_interface +=============== + +`audio_interface` is a FREE software with Free dependency (BSD or APPACHE-2 or MIT ...). + +Instructions +============ + +download the software : + + mkdir -p catkin_ws/src + cd catkin_ws/src + git clone git://github.com/HeeroYui/audio_interface.git + # download dependency + git clone git://github.com/HeeroYui/etk.git + git clone git://github.com/HeeroYui/audio.git + git clone git://github.com/HeeroYui/ejson.git + git clone git://github.com/HeeroYui/airtaudio.git + git clone git://github.com/HeeroYui/drain.git + git clone git://github.com/HeeroYui/river.git + cd ../.. + +Compile software and install : + + cd catkin_ws + catkin_make install + +Run With ROS: +============= + + cd catkin_ws + source install/setup.bash + roslaunch audio_bringup bringup_pc.launch + +Run the player or the recorder: +=============================== + + cd catkin_ws + source install/setup.bash + ./install/lib/test_audio_generator/test_audio_generator_node /audio/ 48000 2 440 10 + ./install/lib/test_audio_recorder/test_audio_recorder_node /audio/microphone recorded.raw + +License (APACHE v2.0) +===================== + +Copyright ewol Edouard DUPIN + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. + diff --git a/license.txt b/license.txt new file mode 100644 index 0000000..904bf32 --- /dev/null +++ b/license.txt @@ -0,0 +1,13 @@ +Copyright ewol Edouard DUPIN + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. \ No newline at end of file