mirrors/gnss-sdr
1
0
Fork 0
mirror of https://github.com/gnss-sdr/gnss-sdr synced 2024-12-14 20:20:35 +00:00
Code Issues Releases Wiki Activity

Improve wording, fix broken link

Browse Source
This commit is contained in:
Carles Fernandez 2020-02-01 14:27:49 +01:00
parent 558f88154a
commit 75b2dbf10e
No known key found for this signature in database
GPG Key ID: 4C583C52B0C3877D
1 changed files with 13 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
src/algorithms/libs/volk_gnsssdr_module/volk_gnsssdr/README.md
View File

@ -27,13 +27,13 @@ architectures) and
providing custom implementations specially designed to take advantage of providing custom implementations specially designed to take advantage of
the specific processor that is running the code). the specific processor that is running the code).
These kernels have some specific features (e.g. saturation arithmetics) These kernels have some specific features (*e.g.*, saturation arithmetics)
that are aimed to GNSS signal processing, but could make them not that are aimed to GNSS signal processing, but could make them not
suitable for its general use in other applications. Check out the suitable for its general use in other applications. Check out the
documentation generated by Doxygen and the *generic* (that is, plain C) documentation generated by Doxygen and the *generic* (that is, plain C)
implementation to see what each kernel is actually doing. implementation to see what each kernel is actually doing.
## How to use VOLK_GNSSSDR: ## How to build VOLK_GNSSSDR:
This library is automatically built and installed along with GNSS-SDR if This library is automatically built and installed along with GNSS-SDR if
it is not found by CMake on your system at configure time. it is not found by CMake on your system at configure time.
@ -55,6 +55,8 @@ Please note that if you are using a compiler supporting the C++17 standard
longer required dependencies. The CMake script will detect that availability for longer required dependencies. The CMake script will detect that availability for
you. you.
### Building on most x86 (32-bit and 64-bit) platforms
In order to build and install the library, go to the base folder of the In order to build and install the library, go to the base folder of the
source code and do: source code and do:
@ -102,9 +104,10 @@ usage.](./docs/images/VOLK_GNSSSDR_Usage_Example.png)
To build for these boards you need specify the correct CMake toolchain file for To build for these boards you need specify the correct CMake toolchain file for
best performance. best performance.
* Raspberry Pi 4 `arm_cortex_a72_hardfp_native.cmake` * Raspberry Pi 4: `arm_cortex_a72_hardfp_native.cmake`
* Raspberry Pi 3 `arm_cortex_a53_hardfp_native.cmake` * Raspberry Pi 3: `arm_cortex_a53_hardfp_native.cmake`
Example for Raspberry Pi 4:
~~~~~~ ~~~~~~
$ mkdir build && cd build $ mkdir build && cd build
$ cmake -DCMAKE_TOOLCHAIN_FILE=../cmake/Toolchains/arm_cortex_a72_hardfp_native.cmake .. $ cmake -DCMAKE_TOOLCHAIN_FILE=../cmake/Toolchains/arm_cortex_a72_hardfp_native.cmake ..
@ -115,14 +118,15 @@ $ volk_gnsssdr_profile
~~~~~~ ~~~~~~
### References ## References
If you use VOLK_GNSSSDR in your research and/or software, please cite If you use VOLK_GNSSSDR in your research and/or software, please cite
the following paper: the following paper:
* C. Fernández-Prades, J. Arribas, P. Closas, [*Accelerating * C. Fernández-Prades, J. Arribas, P. Closas, [*Accelerating
GNSS Software Receivers*](https://zenodo.org/record/266493), in Proc. of GNSS Software Receivers*](https://zenodo.org/record/266493), in Proc. of
the ION GNSS+ 2016 Conference, pp. 44-61, Portland, Oregon, Sept. 12-16, 2016. the ION GNSS+ 2016 Conference, pp. 44-61, Portland, Oregon, Sept. 12-16, 2016.
doi: 10.33012/2016.14576
Citations are useful for the continued development and maintenance of Citations are useful for the continued development and maintenance of
the library. the library.
@ -133,11 +137,11 @@ ___
VOLK_GNSSSDR was originally created by Andres Cecilia Luque in the VOLK_GNSSSDR was originally created by Andres Cecilia Luque in the
framework of the [Summer Of Code In Space (SOCIS framework of the [Summer Of Code In Space (SOCIS
2014)](http://sophia.estec.esa.int/socis2014/?q=about "SOCIS 2014 2014)](https://socis.esa.int/about/ "SOCIS
webpage") program organized by the European Space Agency, and then webpage") program organized by the European Space Agency, and then
evolved and maintained by Carles Fernández-Prades and Javier evolved and maintained by Carles Fernández-Prades and Javier
Arribas. This software is released under the GNU General Public License Arribas. This software is released under the GNU General Public License
version 3, see the file COPYING. version 3, see the file COPYING.
This project is managed by [Centre Tecnologic de Telecomunicacions de This project is managed by [Centre Tecnològic de Telecomunicacions de
Catalunya](http://www.cttc.es "CTTC webpage"). Catalunya](http://www.cttc.es "CTTC webpage").