From 61db351323904267bb9dd94b60f6c7eeb9b784f0 Mon Sep 17 00:00:00 2001 From: Kumi Date: Sat, 10 Feb 2024 12:56:07 +0100 Subject: [PATCH] Add build instructions for LimeSDR software Included detailed build instructions for Debian-based and Arch Linux systems in the README. C++ build dependencies and steps are now documented, facilitating the setup process for new contributors and users. The update ensures clarity on how to compile the software and where to find the resulting `limedriver` executable. --- README.md | 27 ++++++++++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index dfdc36b..ee04d3c 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,31 @@ # Information -These files are used for the control of the LimeSDR based spectrometer. +These files are used for the control of the LimeSDR based spectrometer. With permission from the author Andrin Doll, the files are included in this repository. A. Doll; Pulsed and continuous-wave magnetic resonance spectroscopy using a low-cost software-defined radio. AIP Advances 1 November 2019; 9 (11): 115110. https://doi.org/10.1063/1.5127746 + +## Building + +The software is written in C++ and uses the LimeSuite and HDF5 libraries. The software is built using CMake. + +On Debian-based systems, the following packages are required to build the software: + +``` +sudo apt-get install g++ cmake liblimesuite-dev libhdf5-dev +``` + +On Arch Linux, the following packages are required to build the software: + +``` +sudo pacman -S gcc cmake limesuite hdf5 +``` + +To build the software, run the following commands in the root directory of the repository: + +``` +cmake -B build +cmake --build build +``` + +This will create an executable called `limedriver` in the `build` directory.