From 4c101ea44ccc4a0a7cb397305ef2abb369eb2170 Mon Sep 17 00:00:00 2001 From: Dimitri Stolnikov Date: Sun, 26 May 2013 01:07:24 +0200 Subject: [PATCH] update README --- README | 36 ++++++++++++++++++++++++++++++++++-- 1 file changed, 34 insertions(+), 2 deletions(-) diff --git a/README b/README index e6cd3cc..543c2bb 100644 --- a/README +++ b/README @@ -1,3 +1,35 @@ -Please follow the guidelines from +While primarily being developed for the OsmoSDR hardware, this block as well supports: -http://sdr.osmocom.org/trac/ + * FunCube Dongle through libgnuradio-fcd + * OSMOCOM OsmoSDR Devices through libosmosdr + * Great Scott Gadgets HackRF through libhackrf + * Ettus USRP Devices through Ettus UHD library + * RTL2832U based DVB-T dongles through librtlsdr + * RTL-TCP spectrum server (see librtlsdr project) + * MSi2500 based DVB-T dongles through libmirisdr + * gnuradio .cfile input through libgnuradio-core + +By using the OsmoSDR block you can take advantage of a common software api in your application(s) independent of the underlying radio hardware. + +For installation and usage guidelines please read the documentation available at http://sdr.osmocom.org/trac/wiki/GrOsmoSDR + +For the impatient :) a short excerpt: + +The gnuradio source requires a recent gnuradio (>= v3.6.4.1) to be installed. + +Before building the source you have to make sure that all the dependencies (see list of supported devices above) you are intend to work with are properly installed. The build system of gr-osmosdr will recognize them and enable specific source/sink components thereafter. + +Please note: prior pulling a new version from git and compiling it, please do a "make uninstall" first to properly remove the previous version. + +Building with cmake: + +git clone git://git.osmocom.org/gr-osmosdr +cd gr-osmosdr/ +mkdir build +cd build/ +cmake ../ +make +sudo make install +sudo ldconfig + +NOTE: The OSMOCOM source block will appear under 'Sources' category in GRC menu.