Main Page: Difference between revisions

From GNU Radio
Jump to navigation Jump to search
No edit summary
No edit summary
Line 21: Line 21:
= Documentation =
= Documentation =


# User Documentation
* User Documentation
#* The [[Usage Manual]] contains information about various aspects of GNU Radio not specific to a certain block.
*# The [[Usage Manual]] contains information about various aspects of GNU Radio not specific to a certain block.
#* [[List of Blocks]] (currently a work in progress, use developer docs for any blocks that are not included yet)
*# [[List of Blocks]] (currently a work in progress, use developer docs for any blocks that are not included yet)
# Developer Documentation
* Developer Documentation
#* Our [http://gnuradio.org/doc/doxygen/index.html C++ Manual and API Reference] includes documentation targeted for developers. It is based on Doxygen, using markup comments in the public header files.   
*# Our [http://gnuradio.org/doc/doxygen/index.html C++ Manual and API Reference] includes documentation targeted for developers. It is based on Doxygen, using markup comments in the public header files.   


= Community & Communicating =
= Community & Communicating =

Revision as of 03:59, 14 May 2019

Example GNU Radio Flowgraph

GNU Radio is a free & open-source software development toolkit that provides signal processing blocks to implement software radios. It can be used with readily-available low-cost external RF hardware to create software-defined radios, or without hardware in a simulation-like environment. It is widely used in hobbyist, academic and commercial environments to support both wireless communications research and real-world radio systems.

GNU Radio is licensed under the GNU General Public License (GPL) version 3 or later. All of the code is copyright of the Free Software Foundation.

Getting started

If you've never touched GNU Radio before, these pages will get you started with a running installation of GNU Radio and will show you how to take your first steps with this software radio tool.

The recommended way to get started with GNU Radio is to read the Guided Tutorials.

Documentation

  • User Documentation
    1. The Usage Manual contains information about various aspects of GNU Radio not specific to a certain block.
    2. List of Blocks (currently a work in progress, use developer docs for any blocks that are not included yet)
  • Developer Documentation
    1. Our C++ Manual and API Reference includes documentation targeted for developers. It is based on Doxygen, using markup comments in the public header files.

Community & Communicating

There's a nice community of people involved in GNU Radio. Here's some pointers on how to connect with us.

Developing GNU Radio

Using GNU Radio is nice, but the real fun comes with developing new components for GNU Radio or actually changing the core itself. If you want to write some code, read these articles first. Some of the tutorials are also relevant.

Hardware

Hardware is strictly not part of GNU Radio, which is purely a software library. However, developing radio and signal processing code is even more fun when using hardware to actually transmit and receive, and GNU Radio supports several radio front-ends, either natively or through additional out-of-tree modules.

For a list of supported devices, see our Hardware page.

Further information and 3rd party extensions

There's more stuff to be found for GNU Radio on the web. Check these pages to find tutorials, code and other information on GNU Radio.