nqrduck/limedriver
1
0
Fork 0
mirror of https://github.com/nqrduck/LimeDriver.git synced 2024-11-21 17:42:25 +00:00
Code Issues Projects Releases Packages Wiki Activity

Add build instructions for LimeSDR software

Browse source 
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.
This commit is contained in:
Kumi 2024-02-10 12:56:07 +01:00
parent 40245eabe9
commit 61db351323
Signed by: kumi
GPG key ID: ECBCC9082395383F
1 changed files with 26 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
README.md
View file

@ -4,3 +4,28 @@ 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.