From ce49451e8083113a763922d2ea514de5172deb3c Mon Sep 17 00:00:00 2001 From: straithe Date: Wed, 22 Sep 2021 01:23:09 -0400 Subject: [PATCH] Update installing hackrf software documentation --- ...ips.rst => installing_hackrf_software.rst} | 186 +++++++----------- 1 file changed, 75 insertions(+), 111 deletions(-) rename docs/source/{operating_system_tips.rst => installing_hackrf_software.rst} (68%) diff --git a/docs/source/operating_system_tips.rst b/docs/source/installing_hackrf_software.rst similarity index 68% rename from docs/source/operating_system_tips.rst rename to docs/source/installing_hackrf_software.rst index 7c7bec71..0e579554 100644 --- a/docs/source/operating_system_tips.rst +++ b/docs/source/installing_hackrf_software.rst @@ -1,107 +1,74 @@ .. _operating_system_tips: ================================================ -Operating System Tips +Installing HackRF Software ================================================ -Here are some software setup tips for particular Operating Systems and Linux distributions. - - - -Package managers -~~~~~~~~~~~~~~~~ - -We highly recommend that, unless developing or testing new features of HackRF, most users use build systems or package management provided for their operating system. - - - -Linux -^^^^^ - -Ubuntu / Debian -+++++++++++++++ - -``sudo apt install gqrx-sdr`` - -Fedora / Red Hat -++++++++++++++++ - -``sudo dnf install gnuradio gr-osmosdr hackrf gqrx -y`` - -Gentoo Linux -++++++++++++ - -.. code-block :: sh - - emerge -a net-wireless/hackrf-tools - USE="hackrf" emerge -a net-wireless/gr-osmosdr - - -Arch Linux -++++++++++ - -.. code-block :: sh - - pacman -S gnuradio gnuradio-osmosdr - pacman -S gnuradio-companion - - - -OS X (10.5+) -^^^^^^^^^^^^ - -MacPorts -++++++++ - -``sudo port install gr-osmosdr`` - -Homebrew -++++++++ - -``brew install gr-osmosdr`` - - - -Windows -^^^^^^^ - -Binaries are provided as part of the PothosSDR project, they can be downloaded `here `__. - +Install Using Package Managers +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Unless developing or testing new features for HackRF, we highly recommend that most users use build systems or package managers provided for their operating system. **Our suggested operating system for use with HackRF is Ubuntu**. FreeBSD -^^^^^^^ ++++++++ You can use the binary package: ``# pkg install hackrf`` -You can build and install from ports: +You can also build and install from ports: .. code-block :: sh # cd /usr/ports/comms/hackrf # make install +Linux: Arch ++++++++++++ +.. code-block :: sh -Building from source -~~~~~~~~~~~~~~~~~~~~ + pacman -S gnuradio gnuradio-osmosdr + pacman -S gnuradio-companion -Linux / OS X / \*BSD -^^^^^^^^^^^^^^^^^^^^ +Linux: Fedora / Red Hat ++++++++++++++++++++++++ -Preparing Your System -+++++++++++++++++++++ +``sudo dnf install gnuradio gr-osmosdr hackrf gqrx -y`` -First of all, make sure that your system is up to date using your operating system provided update method. +Linux: Gentoo ++++++++++++++ -Installing using PyBOMBS -^^^^^^^^^^^^^^^^^^^^^^^^ +.. code-block :: sh -The GNU Radio project has a `build system `__ that covers the core libraries, drivers for SDR hardware, and many out of tree modules. PyBOMBs will take care of installing dependencies for you. + emerge -a net-wireless/hackrf-tools + USE="hackrf" emerge -a net-wireless/gr-osmosdr +Linux: Ubuntu / Debian +++++++++++++++++++++++ -Building HackRF tools from source -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +``sudo apt-get install hackrf`` + +OS X (10.5+): Homebrew +++++++++++++++++++++++ + +``brew install gr-osmosdr`` + +OS X (10.5+): MacPorts +++++++++++++++++++++++ + +``sudo port install gr-osmosdr`` + +Windows: Binaries ++++++++++++++++++ + +Binaries are provided as part of the PothosSDR project, they can be downloaded `here `__. + +----------- + +Installing From Source +~~~~~~~~~~~~~~~~~~~~~~ + +Linux / OS X / \*BSD: Building HackRF Software From Source +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Acquire the source for the HackRF tools from either a `release archive `__ or git: ``git clone https://github.com/mossmann/hackrf.git`` @@ -121,11 +88,8 @@ If you have HackRF hardware, you may need to :ref:`update the firmware lib /machine:x64 /def:libfftw3f-3.def`` @@ -153,29 +143,3 @@ Create library definition for MSVC to link to ``C:\fftw-3.3.5-dll64> lib /machin -DFFTW_LIBRARIES=C:\fftw-3.3.5-dll64\libfftw3f-3.lib CMake will produce a solution file named ``HackRF.sln`` and a series of project files which can be built with msbuild as follows: ``c:\hackrf\host\build> msbuild HackRF.sln`` - - - -Cygwin -++++++ - -.. code-block :: sh - - mkdir host/build - cd host/build - cmake ../ -G "Unix Makefiles" -DCMAKE_LEGACY_CYGWIN_WIN32=1 -DLIBUSB_INCLUDE_DIR=/usr/local/include/libusb-1.0/ - make - make install - - - -MinGW -+++++ - -.. code-block :: sh - - mkdir host/build - cd host/build - cmake ../ -G "MSYS Makefiles" -DLIBUSB_INCLUDE_DIR=/usr/local/include/libusb-1.0/ - make - make install