More markdown fixes

This commit is contained in:
Carles Fernandez 2020-02-27 19:50:08 +01:00
parent 66644eac2a
commit 716fa970c4
No known key found for this signature in database
GPG Key ID: 4C583C52B0C3877D
12 changed files with 179 additions and 146 deletions

View File

@ -1,5 +1,7 @@
:+1::tada: Hello, and thanks for contributing to [GNSS-SDR](https://gnss-sdr.org)! :tada::+1: :+1::tada: Hello, and thanks for contributing to
[GNSS-SDR](https://gnss-sdr.org)! :tada::+1:
<!-- prettier-ignore-start -->
[comment]: # ( [comment]: # (
SPDX-License-Identifier: GPL-3.0-or-later SPDX-License-Identifier: GPL-3.0-or-later
) )
@ -7,13 +9,36 @@ SPDX-License-Identifier: GPL-3.0-or-later
[comment]: # ( [comment]: # (
SPDX-FileCopyrightText: 2011-2020 Carles Fernandez-Prades <carles.fernandez@cttc.es> SPDX-FileCopyrightText: 2011-2020 Carles Fernandez-Prades <carles.fernandez@cttc.es>
) )
<!-- prettier-ignore-end -->
Before submitting your pull request, please make sure the following is done: Before submitting your pull request, please make sure the following is done:
1. You undertake the [Contributor Covenant Code of Conduct](https://github.com/gnss-sdr/gnss-sdr/blob/master/CODE_OF_CONDUCT.md).
2. If you are a first-time contributor, after your pull request you will be asked to sign an Individual Contributor License Agreement ([CLA](https://en.wikipedia.org/wiki/Contributor_License_Agreement)) before your code gets accepted into `master`. This license is for your protection as a Contributor as well as for the protection of [CTTC](http://www.cttc.es/); it does not change your rights to use your own contributions for any other purpose. Except for the license granted therein to CTTC and recipients of software distributed by CTTC, you reserve all right, title, and interest in and to your contributions. The information you provide in that CLA will be maintained in accordance with [CTTC's privacy policy](http://www.cttc.es/privacy/).
3. You have read the [Contributing Guidelines](https://github.com/gnss-sdr/gnss-sdr/blob/master/CONTRIBUTING.md).
4. You have read the [coding style guide](https://gnss-sdr.org/coding-style/). Specifically, you have read [about clang-format](https://gnss-sdr.org/coding-style/#use-tools-for-automated-code-formatting) and [about clang-tidy](https://gnss-sdr.org/coding-style/#use-code-linters), and you have applied those tools to your changes.
5. You have forked the [gnss-sdr upstream repository](https://github.com/gnss-sdr/gnss-sdr) and have created your branch from `next` (or any other currently living branch in the upstream repository).
6. Please include a description of your changes here.
**Please feel free to delete this line and the above text once you have read it and in case you want to go on with your pull request, and explain your intend below.** 1. You undertake the
[Contributor Covenant Code of Conduct](https://github.com/gnss-sdr/gnss-sdr/blob/master/CODE_OF_CONDUCT.md).
2. If you are a first-time contributor, after your pull request you will be
asked to sign an Individual Contributor License Agreement
([CLA](https://en.wikipedia.org/wiki/Contributor_License_Agreement)) before
your code gets accepted into `master`. This license is for your protection
as a Contributor as well as for the protection of
[CTTC](http://www.cttc.es/); it does not change your rights to use your own
contributions for any other purpose. Except for the license granted therein
to CTTC and recipients of software distributed by CTTC, you reserve all
right, title, and interest in and to your contributions. The information you
provide in that CLA will be maintained in accordance with
[CTTC's privacy policy](http://www.cttc.es/privacy/).
3. You have read the
[Contributing Guidelines](https://github.com/gnss-sdr/gnss-sdr/blob/master/CONTRIBUTING.md).
4. You have read the [coding style guide](https://gnss-sdr.org/coding-style/).
Specifically, you have read
[about clang-format](https://gnss-sdr.org/coding-style/#use-tools-for-automated-code-formatting)
and [about clang-tidy](https://gnss-sdr.org/coding-style/#use-code-linters),
and you have applied those tools to your changes.
5. You have forked the
[gnss-sdr upstream repository](https://github.com/gnss-sdr/gnss-sdr) and
have created your branch from `next` (or any other currently living branch
in the upstream repository).
6. Please include a description of your changes here.
**Please feel free to delete this line and the above text once you have read it
and in case you want to go on with your pull request, and explain your intend
below.**

View File

@ -80,7 +80,7 @@ jobs:
- name: install-dependencies - name: install-dependencies
run: sudo npm install --global prettier run: sudo npm install --global prettier
- name: check markdown - name: check markdown
run: find . -iname "*.md" -o -iname "README" | xargs prettier --parser markdown --print-width 80 --prose-wrap always --list-different run: find . -iname "*.md" | xargs prettier --parser markdown --print-width 80 --prose-wrap always --list-different
volk-gnsssdr-windows: volk-gnsssdr-windows:

View File

@ -1,42 +1,44 @@
# Contributor Covenant Code of Conduct # Contributor Covenant Code of Conduct
<!-- prettier-ignore-start -->
[comment]: # ( [comment]: # (
SPDX-License-Identifier: GPL-3.0-or-later SPDX-License-Identifier: GPL-3.0-or-later
) )
[comment]: # ( [comment]: # (
SPDX-FileCopyrightText: 2011-2020 Carles Fernandez-Prades <carles.fernandez@cttc.es> SPDX-FileCopyrightText: 2017-2020 Carles Fernandez-Prades <carles.fernandez@cttc.es>
) )
<!-- prettier-ignore-end -->
## Our Pledge ## Our Pledge
In the interest of fostering an open and welcoming environment, we as In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, gender identity and expression, level of experience, size, disability, ethnicity, gender identity and expression, level of
nationality, personal appearance, race, religion, or sexual identity and experience, nationality, personal appearance, race, religion, or sexual identity
orientation. and orientation.
## Our Standards ## Our Standards
Examples of behavior that contributes to creating a positive environment Examples of behavior that contributes to creating a positive environment
include: include:
* Using welcoming and inclusive language - Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences - Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism - Gracefully accepting constructive criticism
* Focusing on what is best for the community - Focusing on what is best for the community
* Showing empathy towards other community members - Showing empathy towards other community members
Examples of unacceptable behavior by participants include: Examples of unacceptable behavior by participants include:
* The use of sexualized language or imagery and unwelcome sexual attention or - The use of sexualized language or imagery and unwelcome sexual attention or
advances advances
* Trolling, insulting/derogatory comments, and personal or political attacks - Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment - Public or private harassment
* Publishing others' private information, such as a physical or electronic - Publishing others' private information, such as a physical or electronic
address, without explicit permission address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a - Other conduct which could reasonably be considered inappropriate in a
professional setting professional setting
## Our Responsibilities ## Our Responsibilities
@ -45,11 +47,11 @@ Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior. response to any instances of unacceptable behavior.
Project maintainers have the right and responsibility to remove, edit, or Project maintainers have the right and responsibility to remove, edit, or reject
reject comments, commits, code, wiki edits, issues, and other contributions comments, commits, code, wiki edits, issues, and other contributions that are
that are not aligned to this Code of Conduct, or to ban temporarily or not aligned to this Code of Conduct, or to ban temporarily or permanently any
permanently any contributor for other behaviors that they deem inappropriate, contributor for other behaviors that they deem inappropriate, threatening,
threatening, offensive, or harmful. offensive, or harmful.
## Scope ## Scope
@ -66,8 +68,9 @@ Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at carles.fernandez@cttc.es. All reported by contacting the project team at carles.fernandez@cttc.es. All
complaints will be reviewed and investigated and will result in a response that complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident. obligated to maintain confidentiality with regard to the reporter of an
Further details of specific enforcement policies may be posted separately. incident. Further details of specific enforcement policies may be posted
separately.
Project maintainers who do not follow or enforce the Code of Conduct in good Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other faith may face temporary or permanent repercussions as determined by other
@ -75,8 +78,9 @@ members of the project's leadership.
## Attribution ## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, This Code of Conduct is adapted from the [Contributor Covenant][homepage],
available at [https://contributor-covenant.org/version/1/4][version] version 1.4, available at
[https://contributor-covenant.org/version/1/4][version]
[homepage]: https://contributor-covenant.org [homepage]: https://contributor-covenant.org
[version]: https://contributor-covenant.org/version/1/4/ [version]: https://contributor-covenant.org/version/1/4/

View File

@ -1,5 +1,6 @@
# Contributing to GNSS-SDR # Contributing to GNSS-SDR
<!-- prettier-ignore-start -->
[comment]: # ( [comment]: # (
SPDX-License-Identifier: GPL-3.0-or-later SPDX-License-Identifier: GPL-3.0-or-later
) )
@ -7,90 +8,87 @@ SPDX-License-Identifier: GPL-3.0-or-later
[comment]: # ( [comment]: # (
SPDX-FileCopyrightText: 2011-2020 Carles Fernandez-Prades <carles.fernandez@cttc.es> SPDX-FileCopyrightText: 2011-2020 Carles Fernandez-Prades <carles.fernandez@cttc.es>
) )
<!-- prettier-ignore-end -->
:+1::tada: Thanks for taking the time to contribute! :tada::+1: :+1::tada: Thanks for taking the time to contribute! :tada::+1:
Third-party contributions are essential for keeping GNSS-SDR Third-party contributions are essential for keeping GNSS-SDR continuously
continuously improving. We simply cannot access the huge number of improving. We simply cannot access the huge number of platforms and myriad
platforms and myriad configurations for running GNSS-SDR. We want to configurations for running GNSS-SDR. We want to keep it as easy as possible to
keep it as easy as possible to contribute changes that get things contribute changes that get things working in your environment. There are a few
working in your environment. There are a few guidelines that we need guidelines that we need contributors to follow so that we can have a chance of
contributors to follow so that we can have a chance of keeping on top of keeping on top of things.
things.
The following is a set of guidelines for contributing to GNSS-SDR, which The following is a set of guidelines for contributing to GNSS-SDR, which is
is hosted in the [GNSS-SDR Organization](https://github.com/gnss-sdr) on hosted in the [GNSS-SDR Organization](https://github.com/gnss-sdr) on GitHub.
GitHub. These are just guidelines, not rules. Use your best judgment, These are just guidelines, not rules. Use your best judgment, and feel free to
and feel free to propose changes to this document in a [pull propose changes to this document in a
request](#how-to-submit-a-pull-request). [pull request](#how-to-submit-a-pull-request).
## Code of Conduct ## Code of Conduct
This project adheres to the Contributor Covenant [code of This project adheres to the Contributor Covenant
conduct](CODE_OF_CONDUCT.md). By participating, you are expected to [code of conduct](CODE_OF_CONDUCT.md). By participating, you are expected to
uphold this code. Please report unacceptable behavior. uphold this code. Please report unacceptable behavior.
## Reporting an issue ## Reporting an issue
Have you found a bug in the code which is not in the [list of known Have you found a bug in the code which is not in the
bugs](https://github.com/gnss-sdr/gnss-sdr/issues)? Do you have a [list of known bugs](https://github.com/gnss-sdr/gnss-sdr/issues)? Do you have a
suggestion for improvement? Then by all means please [submit a new suggestion for improvement? Then by all means please
issue](https://github.com/gnss-sdr/gnss-sdr/issues/new), and do not [submit a new issue](https://github.com/gnss-sdr/gnss-sdr/issues/new), and do
hesitate to comment on existing [open not hesitate to comment on existing
issues](https://github.com/gnss-sdr/gnss-sdr/issues). [open issues](https://github.com/gnss-sdr/gnss-sdr/issues).
When filling a new issue, please remember to: When filling a new issue, please remember to:
* **Use a clear and descriptive title** for the issue to identify the - **Use a clear and descriptive title** for the issue to identify the problem.
problem.
* **Describe the exact steps which reproduce the problem** in as many - **Describe the exact steps which reproduce the problem** in as many details as
details as possible. For example, start by describing your computing possible. For example, start by describing your computing platform (Operating
platform (Operating System and version, how did you installed GNSS-SDR System and version, how did you installed GNSS-SDR and its dependencies, what
and its dependencies, what file or front-end are you using as a signal file or front-end are you using as a signal source, etc.). You can also
source, etc.). You can also include the configuration file you are include the configuration file you are using, or a dump of the terminal output
using, or a dump of the terminal output you are getting. The more you are getting. The more information you provide, the more chances to get
information you provide, the more chances to get useful answers. useful answers.
* **Please be patient**. This organization is run on a volunteer basis, - **Please be patient**. This organization is run on a volunteer basis, so it
so it can take some time to the Developer Team to reach your issue. can take some time to the Developer Team to reach your issue. They will do
They will do their best to fix it as soon as possible. their best to fix it as soon as possible.
* If you opened an issue that is now solved, it is a good practice to - If you opened an issue that is now solved, it is a good practice to **close
**close it**. it**.
The list of [open issues](https://github.com/gnss-sdr/gnss-sdr/issues)
can be a good starting point and a source of ideas if you are looking to
contribute to the source code.
The list of [open issues](https://github.com/gnss-sdr/gnss-sdr/issues) can be a
good starting point and a source of ideas if you are looking to contribute to
the source code.
## Contributing to the source code ## Contributing to the source code
### Preliminaries ### Preliminaries
1. If you still have not done so, [create your personal account on 1. If you still have not done so,
GitHub](https://github.com/join). [create your personal account on GitHub](https://github.com/join).
2. [Fork GNSS-SDR from 2. [Fork GNSS-SDR from GitHub](https://github.com/gnss-sdr/gnss-sdr/fork). This
GitHub](https://github.com/gnss-sdr/gnss-sdr/fork). This will copy the will copy the whole gnss-sdr repository to your personal account.
whole gnss-sdr repository to your personal account.
3. Then, go to your favorite working folder in your computer and 3. Then, go to your favorite working folder in your computer and clone your
clone your forked repository by typing (replacing ```YOUR_USERNAME``` by forked repository by typing (replacing `YOUR_USERNAME` by the actual
the actual username of your GitHub account): username of your GitHub account):
$ git clone https://github.com/YOUR_USERNAME/gnss-sdr $ git clone https://github.com/YOUR_USERNAME/gnss-sdr
4. Your forked repository https://github.com/YOUR_USERNAME/gnss-sdr 4. Your forked repository https://github.com/YOUR_USERNAME/gnss-sdr will
will receive the default name of `origin`. You can also add the original receive the default name of `origin`. You can also add the original gnss-sdr
gnss-sdr repository, which is usually referred to as `upstream`: repository, which is usually referred to as `upstream`:
$ cd gnss-sdr $ cd gnss-sdr
$ git remote add upstream https://github.com/gnss-sdr/gnss-sdr.git $ git remote add upstream https://github.com/gnss-sdr/gnss-sdr.git
To verify the new upstream repository you have specified for your fork, To verify the new upstream repository you have specified for your fork, type
type `git remote -v`. You should see the URL for your fork as `origin`, `git remote -v`. You should see the URL for your fork as `origin`, and the URL
and the URL for the original repository as `upstream`: for the original repository as `upstream`:
``` ```
$ git remote -v $ git remote -v
@ -102,33 +100,32 @@ upstream https://github.com/gnss-sdr/gnss-sdr.git (push)
### Start working on your contribution ### Start working on your contribution
Checkout the `next` branch of the git repository in order to get Checkout the `next` branch of the git repository in order to get synchronized
synchronized with the latest development code: with the latest development code:
``` ```
$ git checkout next $ git checkout next
$ git pull upstream next $ git pull upstream next
``` ```
When start working in a new improvement, please **always** branch off When start working in a new improvement, please **always** branch off from
from `next`. Open a new branch and start working on it: `next`. Open a new branch and start working on it:
``` ```
$ git checkout -b my_feature $ git checkout -b my_feature
``` ```
Now you can do changes, add files, do commits (please take a look at Now you can do changes, add files, do commits (please take a look at
[how to write good commit [how to write good commit messages](https://chris.beams.io/posts/git-commit/)!)
messages](https://chris.beams.io/posts/git-commit/)!) and push them to and push them to your repository:
your repository:
``` ```
$ git push origin my_feature $ git push origin my_feature
``` ```
If there have been new pushes to the `next` branch of the `upstream` If there have been new pushes to the `next` branch of the `upstream` repository
repository since the last time you pulled from it, you might want to put since the last time you pulled from it, you might want to put your commits on
your commits on top of them (this is mandatory for pull requests): top of them (this is mandatory for pull requests):
``` ```
$ git pull --rebase upstream next $ git pull --rebase upstream next
@ -136,55 +133,51 @@ $ git pull --rebase upstream next
### How to submit a pull request ### How to submit a pull request
Before submitting your code, please be sure to [apply clang-format](https://gnss-sdr.org/coding-style/#use-tools-for-automated-code-formatting). Before submitting your code, please be sure to
[apply clang-format](https://gnss-sdr.org/coding-style/#use-tools-for-automated-code-formatting).
When the contribution is ready, you can [submit a pull When the contribution is ready, you can
request](https://github.com/gnss-sdr/gnss-sdr/compare/). Head to your [submit a pull request](https://github.com/gnss-sdr/gnss-sdr/compare/). Head to
GitHub repository, switch to your `my_feature` branch, and click the your GitHub repository, switch to your `my_feature` branch, and click the
_**Pull Request**_ button, which will do all the work for you. Code _**Pull Request**_ button, which will do all the work for you. Code comparison
comparison must be always to the `next` branch. must be always to the `next` branch.
Once a pull request is sent, the Developer Team can review the set of Once a pull request is sent, the Developer Team can review the set of changes,
changes, discuss potential modifications, and even push follow-up discuss potential modifications, and even push follow-up commits if necessary.
commits if necessary.
Some things that will increase the chance that your pull request is Some things that will increase the chance that your pull request is accepted:
accepted:
* Avoid platform-dependent code. If your code require external - Avoid platform-dependent code. If your code require external dependencies,
dependencies, they must be available as packages in [Debian OldStable](https://wiki.debian.org/DebianOldStable). they must be available as packages in
* Write tests. [Debian OldStable](https://wiki.debian.org/DebianOldStable).
* Follow our [coding style guide](https://gnss-sdr.org/coding-style/). - Write tests.
Specifically, please make sure that you have applied - Follow our [coding style guide](https://gnss-sdr.org/coding-style/).
[clang-format](https://clang.llvm.org/docs/ClangFormat.html) and Specifically, please make sure that you have applied
[clang-tidy](https://clang.llvm.org/extra/clang-tidy/) to your changes before [clang-format](https://clang.llvm.org/docs/ClangFormat.html) and
you do your pull request. Please check the [clang-tidy](https://clang.llvm.org/extra/clang-tidy/) to your changes before
[final recommendations](https://gnss-sdr.org/coding-style/#final-recommendations) you do your pull request. Please check the
for guidelines on how to apply those tools. [final recommendations](https://gnss-sdr.org/coding-style/#final-recommendations)
* Write a descriptive and detailed summary. Please consider that for guidelines on how to apply those tools.
reviewing pull requests is hard, so include as much information as - Write a descriptive and detailed summary. Please consider that reviewing pull
possible to make your pull request's intent clear. requests is hard, so include as much information as possible to make your pull
request's intent clear.
For more details about Git usage, please check out [our
tutorial](https://gnss-sdr.org/docs/tutorials/using-git/).
For more details about Git usage, please check out
[our tutorial](https://gnss-sdr.org/docs/tutorials/using-git/).
## Contributing to the website ## Contributing to the website
The content of https://gnss-sdr.org lives in a GitHub repository at The content of https://gnss-sdr.org lives in a GitHub repository at
https://github.com/gnss-sdr/geniuss-place https://github.com/gnss-sdr/geniuss-place
You can fork that repository, reproduce the entire website on your You can fork that repository, reproduce the entire website on your computer
computer using [Jekyll](https://jekyllrb.com/), do changes and submit using [Jekyll](https://jekyllrb.com/), do changes and submit pull requests, just
pull requests, just as explained above. For more details, please check as explained above. For more details, please check out
out [how to contribute](https://gnss-sdr.org/contribute/). [how to contribute](https://gnss-sdr.org/contribute/).
Last but not the least, you can leave your comments on the website. Last but not the least, you can leave your comments on the website.
---
------
![GeNiuSS ![GeNiuSS
contributes](https://gnss-sdr.org/assets/images/geniuss-contribute.png) contributes](https://gnss-sdr.org/assets/images/geniuss-contribute.png)

View File

@ -2,6 +2,7 @@
[![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) [![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
<!-- prettier-ignore-start -->
[comment]: # ( [comment]: # (
SPDX-License-Identifier: GPL-3.0-or-later SPDX-License-Identifier: GPL-3.0-or-later
) )
@ -9,6 +10,7 @@ SPDX-License-Identifier: GPL-3.0-or-later
[comment]: # ( [comment]: # (
SPDX-FileCopyrightText: 2011-2020 Carles Fernandez-Prades <carles.fernandez@cttc.es> SPDX-FileCopyrightText: 2011-2020 Carles Fernandez-Prades <carles.fernandez@cttc.es>
) )
<!-- prettier-ignore-end -->
**Welcome to GNSS-SDR!** **Welcome to GNSS-SDR!**
@ -42,7 +44,6 @@ a framework for the development of new features. Please visit
[https://gnss-sdr.org](https://gnss-sdr.org "GNSS-SDR website") for more [https://gnss-sdr.org](https://gnss-sdr.org "GNSS-SDR website") for more
information about this open source software-defined GNSS receiver. information about this open source software-defined GNSS receiver.
# How to build GNSS-SDR # How to build GNSS-SDR
This section describes how to set up the compilation environment in GNU/Linux or This section describes how to set up the compilation environment in GNU/Linux or
@ -703,7 +704,6 @@ substitutes a generic, non-SIMD implementation.
More details can be found in our tutorial about More details can be found in our tutorial about
[GNSS-SDR configuration options at building time](https://gnss-sdr.org/docs/tutorials/using-git/ "Configuration options at building time"). [GNSS-SDR configuration options at building time](https://gnss-sdr.org/docs/tutorials/using-git/ "Configuration options at building time").
## <a name="macosx">macOS</a> ## <a name="macosx">macOS</a>
GNSS-SDR can be built on macOS (or the former Mac OS X), starting from 10.9 GNSS-SDR can be built on macOS (or the former Mac OS X), starting from 10.9
@ -858,7 +858,6 @@ The CMake script will create Makefiles that download, build and link Armadillo,
Gflags, Glog, Matio, Protocol Buffers, PugiXML and Google Test on the fly at Gflags, Glog, Matio, Protocol Buffers, PugiXML and Google Test on the fly at
compile time if they are not detected in your machine. compile time if they are not detected in your machine.
## Other builds ## Other builds
- **Docker image**: A technology providing operating-system-level virtualization - **Docker image**: A technology providing operating-system-level virtualization
@ -888,7 +887,6 @@ compile time if they are not detected in your machine.
[Cross-compiling GNSS-SDR](https://gnss-sdr.org/docs/tutorials/cross-compiling/) [Cross-compiling GNSS-SDR](https://gnss-sdr.org/docs/tutorials/cross-compiling/)
for instructions. for instructions.
# Updating GNSS-SDR # Updating GNSS-SDR
If you cloned or forked GNSS-SDR some time ago, it is possible that some If you cloned or forked GNSS-SDR some time ago, it is possible that some
@ -928,7 +926,6 @@ There is a more controlled way to upgrade your repository, which is to use the
Git commands `fetch` and `merge`, as described in our Git commands `fetch` and `merge`, as described in our
[Git Tutorial](https://gnss-sdr.org/docs/tutorials/using-git/ "Using Git"). [Git Tutorial](https://gnss-sdr.org/docs/tutorials/using-git/ "Using Git").
# Getting started # Getting started
1. After building the code, you will find the `gnss-sdr` executable file at 1. After building the code, you will find the `gnss-sdr` executable file at

View File

@ -1,5 +1,6 @@
# Custom structured data format definitions # Custom structured data format definitions
<!-- prettier-ignore-start -->
[comment]: # ( [comment]: # (
SPDX-License-Identifier: GPL-3.0-or-later SPDX-License-Identifier: GPL-3.0-or-later
) )
@ -7,9 +8,11 @@ SPDX-License-Identifier: GPL-3.0-or-later
[comment]: # ( [comment]: # (
SPDX-FileCopyrightText: 2011-2020 Carles Fernandez-Prades <carles.fernandez@cttc.es> SPDX-FileCopyrightText: 2011-2020 Carles Fernandez-Prades <carles.fernandez@cttc.es>
) )
<!-- prettier-ignore-end -->
Files in this folder describe structured data formats that are generated by Files in this folder describe structured data formats that are generated by
GNSS-SDR. They use [Protocol Buffers](https://developers.google.com/protocol-buffers/)' GNSS-SDR. They use
[Protocol Buffers](https://developers.google.com/protocol-buffers/)'
[proto3](https://developers.google.com/protocol-buffers/docs/proto3) syntax. [proto3](https://developers.google.com/protocol-buffers/docs/proto3) syntax.
From those files, the protocol buffer compiler creates classes that implement From those files, the protocol buffer compiler creates classes that implement

View File

@ -1,5 +1,6 @@
# XML Schemas for Assisted GNSS-SDR # XML Schemas for Assisted GNSS-SDR
<!-- prettier-ignore-start -->
[comment]: # ( [comment]: # (
SPDX-License-Identifier: GPL-3.0-or-later SPDX-License-Identifier: GPL-3.0-or-later
) )
@ -7,6 +8,7 @@ SPDX-License-Identifier: GPL-3.0-or-later
[comment]: # ( [comment]: # (
SPDX-FileCopyrightText: 2011-2020 Carles Fernandez-Prades <carles.fernandez@cttc.es> SPDX-FileCopyrightText: 2011-2020 Carles Fernandez-Prades <carles.fernandez@cttc.es>
) )
<!-- prettier-ignore-end -->
GNSS-SDR can read assistance data from GNSS-SDR can read assistance data from
[Extensible Markup Language (XML)](https://www.w3.org/XML/) files for faster [Extensible Markup Language (XML)](https://www.w3.org/XML/) files for faster

View File

@ -1,5 +1,6 @@
[![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) [![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
<!-- prettier-ignore-start -->
[comment]: # ( [comment]: # (
SPDX-License-Identifier: GPL-3.0-or-later SPDX-License-Identifier: GPL-3.0-or-later
) )
@ -7,6 +8,7 @@ SPDX-License-Identifier: GPL-3.0-or-later
[comment]: # ( [comment]: # (
SPDX-FileCopyrightText: 2011-2020 Carles Fernandez-Prades <carles.fernandez@cttc.es> SPDX-FileCopyrightText: 2011-2020 Carles Fernandez-Prades <carles.fernandez@cttc.es>
) )
<!-- prettier-ignore-end -->
# Welcome to VOLK_GNSSSDR, the Vector-Optimized Library of Kernels for GNSS-SDR # Welcome to VOLK_GNSSSDR, the Vector-Optimized Library of Kernels for GNSS-SDR
@ -47,7 +49,6 @@ baseband processor:
![Example of VOLK_GNSSSDR ![Example of VOLK_GNSSSDR
usage.](./docs/images/VOLK_GNSSSDR_Usage_Example.png) usage.](./docs/images/VOLK_GNSSSDR_Usage_Example.png)
## How to build VOLK_GNSSSDR: ## How to build VOLK_GNSSSDR:
This library is automatically built and installed along with GNSS-SDR if it is This library is automatically built and installed along with GNSS-SDR if it is
@ -69,7 +70,6 @@ instance, gcc >= 8.0), specifically the std::filesystem library, packages
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 ### 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 source In order to build and install the library, go to the base folder of the source

View File

@ -18,8 +18,9 @@ modules. If you need to design or work with VOLK kernels away from
the canonical VOLK library, this is the tool. If you need to tailor the canonical VOLK library, this is the tool. If you need to tailor
your own VOLK library for whatever reason, this is the tool. your own VOLK library for whatever reason, this is the tool.
The canonical VOLK library installs a volk.h and a libvolk.so. Your own library The canonical VOLK-GNSSSDR library installs a volk_gnsssdr.h and a
will install volk_$name.h and libvolk_$name.so. libvolk_gnsssdr.so. Your own library will install volk_gnsssdr_$name.h
and libvolk_gnsssdr_$name.so.
Ya Gronk? Ya Gronk?
Good. Good.

View File

@ -1,12 +1,14 @@
## Continuous Reproducibility in GNSS Signal Processing ## Continuous Reproducibility in GNSS Signal Processing
<!-- prettier-ignore-start -->
[comment]: # ( [comment]: # (
SPDX-License-Identifier: GPL-3.0-or-later SPDX-License-Identifier: GPL-3.0-or-later
) )
[comment]: # ( [comment]: # (
SPDX-FileCopyrightText: 2011-2020 Carles Fernandez-Prades <carles.fernandez@cttc.es> SPDX-FileCopyrightText: 2018 Carles Fernandez-Prades <carles.fernandez@cttc.es>
) )
<!-- prettier-ignore-end -->
This folder contains files required for the reproduction of the experiment This folder contains files required for the reproduction of the experiment
proposed in: proposed in:

View File

@ -1,12 +1,14 @@
## obsdiff ## obsdiff
<!-- prettier-ignore-start -->
[comment]: # ( [comment]: # (
SPDX-License-Identifier: GPL-3.0-or-later SPDX-License-Identifier: GPL-3.0-or-later
) )
[comment]: # ( [comment]: # (
SPDX-FileCopyrightText: Javier Arribas, 2020. <jarribas@cttc.es> SPDX-FileCopyrightText: 2020 Carles Fernandez-Prades <carles.fernandez@cttc.es>
) )
<!-- prettier-ignore-end -->
This program computes single-differences and double-differences from RINEX This program computes single-differences and double-differences from RINEX
observation files. observation files.
@ -94,6 +96,7 @@ boolean flags.
Available command-line flags: Available command-line flags:
<!-- prettier-ignore-start -->
| **Command-line flag** | **Default value** | **Description** | | **Command-line flag** | **Default value** | **Description** |
|:-------------------------:|:-----------------:|:-----------------| |:-------------------------:|:-----------------:|:-----------------|
| `--skip_obs_transitory_s` | `30.0` | Skip the initial observable outputs to avoid transitory results [s]. | | `--skip_obs_transitory_s` | `30.0` | Skip the initial observable outputs to avoid transitory results [s]. |
@ -107,3 +110,4 @@ Available command-line flags:
| `--remove_rx_clock_error` | `false` | Compute and remove the receivers clock error prior to compute observable differences (requires a valid RINEX nav file for both receivers) | | `--remove_rx_clock_error` | `false` | Compute and remove the receivers clock error prior to compute observable differences (requires a valid RINEX nav file for both receivers) |
| `--rinex_nav` | `reference.nav` | Filename of reference RINEX navigation file. Only needed if `remove_rx_clock_error` is set to `true`. | | `--rinex_nav` | `reference.nav` | Filename of reference RINEX navigation file. Only needed if `remove_rx_clock_error` is set to `true`. |
| `--show_plots` | `true` | [`true`, `false`]: If `true`, and if [gnuplot](http://www.gnuplot.info/) is found on the system, displays results plots on screen. Please set it to `false` for non-interactive testing. | | `--show_plots` | `true` | [`true`, `false`]: If `true`, and if [gnuplot](http://www.gnuplot.info/) is found on the system, displays results plots on screen. Please set it to `false` for non-interactive testing. |
<!-- prettier-ignore-end -->

View File

@ -1,12 +1,14 @@
## Rinex2assist ## Rinex2assist
<!-- prettier-ignore-start -->
[comment]: # ( [comment]: # (
SPDX-License-Identifier: GPL-3.0-or-later SPDX-License-Identifier: GPL-3.0-or-later
) )
[comment]: # ( [comment]: # (
SPDX-FileCopyrightText: 2011-2020 Carles Fernandez-Prades <carles.fernandez@cttc.es> SPDX-FileCopyrightText: 2019-2020 Carles Fernandez-Prades <carles.fernandez@cttc.es>
) )
<!-- prettier-ignore-end -->
This program reads data from RINEX navigation files and generates XML files that This program reads data from RINEX navigation files and generates XML files that
can be read by GNSS-SDR as Assisted GNSS data. can be read by GNSS-SDR as Assisted GNSS data.