mirror of https://github.com/gnss-sdr/gnss-sdr
More markdown fixes
This commit is contained in:
Carles Fernandez
parent
66644eac2a
commit
716fa970c4
|
|
@ -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]: # (
|
||||
SPDX-License-Identifier: GPL-3.0-or-later
|
||||
)
|
||||
|
|
@ -7,13 +9,36 @@ SPDX-License-Identifier: GPL-3.0-or-later
|
|||
[comment]: # (
|
||||
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:
|
||||
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.**
|
||||
|
|
|
|||
|
|
@ -80,7 +80,7 @@ jobs:
|
|||
- name: install-dependencies
|
||||
run: sudo npm install --global prettier
|
||||
- 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:
|
||||
|
|
|
|||
|
|
@ -1,42 +1,44 @@
|
|||
# Contributor Covenant Code of Conduct
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
[comment]: # (
|
||||
SPDX-License-Identifier: GPL-3.0-or-later
|
||||
)
|
||||
|
||||
[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
|
||||
|
||||
In the interest of fostering an open and welcoming environment, we as
|
||||
contributors and maintainers pledge to making participation in our project and
|
||||
our community a harassment-free experience for everyone, regardless of age, body
|
||||
size, disability, ethnicity, gender identity and expression, level of experience,
|
||||
nationality, personal appearance, race, religion, or sexual identity and
|
||||
orientation.
|
||||
size, disability, ethnicity, gender identity and expression, level of
|
||||
experience, nationality, personal appearance, race, religion, or sexual identity
|
||||
and orientation.
|
||||
|
||||
## Our Standards
|
||||
|
||||
Examples of behavior that contributes to creating a positive environment
|
||||
include:
|
||||
|
||||
* Using welcoming and inclusive language
|
||||
* Being respectful of differing viewpoints and experiences
|
||||
* Gracefully accepting constructive criticism
|
||||
* Focusing on what is best for the community
|
||||
* Showing empathy towards other community members
|
||||
- Using welcoming and inclusive language
|
||||
- Being respectful of differing viewpoints and experiences
|
||||
- Gracefully accepting constructive criticism
|
||||
- Focusing on what is best for the community
|
||||
- Showing empathy towards other community members
|
||||
|
||||
Examples of unacceptable behavior by participants include:
|
||||
|
||||
* The use of sexualized language or imagery and unwelcome sexual attention or
|
||||
advances
|
||||
* Trolling, insulting/derogatory comments, and personal or political attacks
|
||||
* Public or private harassment
|
||||
* Publishing others' private information, such as a physical or electronic
|
||||
- The use of sexualized language or imagery and unwelcome sexual attention or
|
||||
advances
|
||||
- Trolling, insulting/derogatory comments, and personal or political attacks
|
||||
- Public or private harassment
|
||||
- Publishing others' private information, such as a physical or electronic
|
||||
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
|
||||
|
||||
## 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
|
||||
response to any instances of unacceptable behavior.
|
||||
|
||||
Project maintainers have the right and responsibility to remove, edit, or
|
||||
reject comments, commits, code, wiki edits, issues, and other contributions
|
||||
that are not aligned to this Code of Conduct, or to ban temporarily or
|
||||
permanently any contributor for other behaviors that they deem inappropriate,
|
||||
threatening, offensive, or harmful.
|
||||
Project maintainers have the right and responsibility to remove, edit, or reject
|
||||
comments, commits, code, wiki edits, issues, and other contributions that are
|
||||
not aligned to this Code of Conduct, or to ban temporarily or permanently any
|
||||
contributor for other behaviors that they deem inappropriate, threatening,
|
||||
offensive, or harmful.
|
||||
|
||||
## 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
|
||||
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
|
||||
obligated to maintain confidentiality with regard to the reporter of an incident.
|
||||
Further details of specific enforcement policies may be posted separately.
|
||||
obligated to maintain confidentiality with regard to the reporter of an
|
||||
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
|
||||
faith may face temporary or permanent repercussions as determined by other
|
||||
|
|
@ -75,8 +78,9 @@ members of the project's leadership.
|
|||
|
||||
## Attribution
|
||||
|
||||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
|
||||
available at [https://contributor-covenant.org/version/1/4][version]
|
||||
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
||||
version 1.4, available at
|
||||
[https://contributor-covenant.org/version/1/4][version]
|
||||
|
||||
[homepage]: https://contributor-covenant.org
|
||||
[version]: https://contributor-covenant.org/version/1/4/
|
||||
|
|
|
|||
193
CONTRIBUTING.md
193
CONTRIBUTING.md
|
|
@ -1,5 +1,6 @@
|
|||
# Contributing to GNSS-SDR
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
[comment]: # (
|
||||
SPDX-License-Identifier: GPL-3.0-or-later
|
||||
)
|
||||
|
|
@ -7,90 +8,87 @@ SPDX-License-Identifier: GPL-3.0-or-later
|
|||
[comment]: # (
|
||||
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:
|
||||
|
||||
Third-party contributions are essential for keeping GNSS-SDR
|
||||
continuously improving. We simply cannot access the huge number of
|
||||
platforms and myriad configurations for running GNSS-SDR. We want to
|
||||
keep it as easy as possible to contribute changes that get things
|
||||
working in your environment. There are a few guidelines that we need
|
||||
contributors to follow so that we can have a chance of keeping on top of
|
||||
things.
|
||||
Third-party contributions are essential for keeping GNSS-SDR continuously
|
||||
improving. We simply cannot access the huge number of platforms and myriad
|
||||
configurations for running GNSS-SDR. We want to keep it as easy as possible to
|
||||
contribute changes that get things working in your environment. There are a few
|
||||
guidelines that we need contributors to follow so that we can have a chance of
|
||||
keeping on top of things.
|
||||
|
||||
The following is a set of guidelines for contributing to GNSS-SDR, which
|
||||
is hosted in the [GNSS-SDR Organization](https://github.com/gnss-sdr) on
|
||||
GitHub. These are just guidelines, not rules. Use your best judgment,
|
||||
and feel free to propose changes to this document in a [pull
|
||||
request](#how-to-submit-a-pull-request).
|
||||
The following is a set of guidelines for contributing to GNSS-SDR, which is
|
||||
hosted in the [GNSS-SDR Organization](https://github.com/gnss-sdr) on GitHub.
|
||||
These are just guidelines, not rules. Use your best judgment, and feel free to
|
||||
propose changes to this document in a
|
||||
[pull request](#how-to-submit-a-pull-request).
|
||||
|
||||
## Code of Conduct
|
||||
|
||||
This project adheres to the Contributor Covenant [code of
|
||||
conduct](CODE_OF_CONDUCT.md). By participating, you are expected to
|
||||
This project adheres to the Contributor Covenant
|
||||
[code of conduct](CODE_OF_CONDUCT.md). By participating, you are expected to
|
||||
uphold this code. Please report unacceptable behavior.
|
||||
|
||||
## Reporting an issue
|
||||
|
||||
Have you found a bug in the code which is not in the [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
|
||||
issue](https://github.com/gnss-sdr/gnss-sdr/issues/new), and do not
|
||||
hesitate to comment on existing [open
|
||||
issues](https://github.com/gnss-sdr/gnss-sdr/issues).
|
||||
Have you found a bug in the code which is not in the
|
||||
[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 issue](https://github.com/gnss-sdr/gnss-sdr/issues/new), and do
|
||||
not hesitate to comment on existing
|
||||
[open issues](https://github.com/gnss-sdr/gnss-sdr/issues).
|
||||
|
||||
When filling a new issue, please remember to:
|
||||
|
||||
* **Use a clear and descriptive title** for the issue to identify the
|
||||
problem.
|
||||
- **Use a clear and descriptive title** for the issue to identify the problem.
|
||||
|
||||
* **Describe the exact steps which reproduce the problem** in as many
|
||||
details as possible. For example, start by describing your computing
|
||||
platform (Operating System and version, how did you installed GNSS-SDR
|
||||
and its dependencies, what file or front-end are you using as a signal
|
||||
source, etc.). You can also include the configuration file you are
|
||||
using, or a dump of the terminal output you are getting. The more
|
||||
information you provide, the more chances to get useful answers.
|
||||
- **Describe the exact steps which reproduce the problem** in as many details as
|
||||
possible. For example, start by describing your computing platform (Operating
|
||||
System and version, how did you installed GNSS-SDR and its dependencies, what
|
||||
file or front-end are you using as a signal source, etc.). You can also
|
||||
include the configuration file you are using, or a dump of the terminal output
|
||||
you are getting. The more information you provide, the more chances to get
|
||||
useful answers.
|
||||
|
||||
* **Please be patient**. This organization is run on a volunteer basis,
|
||||
so it can take some time to the Developer Team to reach your issue.
|
||||
They will do their best to fix it as soon as possible.
|
||||
- **Please be patient**. This organization is run on a volunteer basis, so it
|
||||
can take some time to the Developer Team to reach your issue. They will do
|
||||
their best to fix it as soon as possible.
|
||||
|
||||
* If you opened an issue that is now solved, it is a good practice to
|
||||
**close 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.
|
||||
- If you opened an issue that is now solved, it is a good practice to **close
|
||||
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.
|
||||
|
||||
## Contributing to the source code
|
||||
|
||||
### Preliminaries
|
||||
|
||||
1. If you still have not done so, [create your personal account on
|
||||
GitHub](https://github.com/join).
|
||||
1. If you still have not done so,
|
||||
[create your personal account on GitHub](https://github.com/join).
|
||||
|
||||
2. [Fork GNSS-SDR from
|
||||
GitHub](https://github.com/gnss-sdr/gnss-sdr/fork). This will copy the
|
||||
whole gnss-sdr repository to your personal account.
|
||||
2. [Fork GNSS-SDR from GitHub](https://github.com/gnss-sdr/gnss-sdr/fork). This
|
||||
will copy the whole gnss-sdr repository to your personal account.
|
||||
|
||||
3. Then, go to your favorite working folder in your computer and
|
||||
clone your forked repository by typing (replacing ```YOUR_USERNAME``` by
|
||||
the actual username of your GitHub account):
|
||||
3. Then, go to your favorite working folder in your computer and clone your
|
||||
forked repository by typing (replacing `YOUR_USERNAME` by the actual
|
||||
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
|
||||
will receive the default name of `origin`. You can also add the original
|
||||
gnss-sdr repository, which is usually referred to as `upstream`:
|
||||
4. Your forked repository https://github.com/YOUR_USERNAME/gnss-sdr will
|
||||
receive the default name of `origin`. You can also add the original gnss-sdr
|
||||
repository, which is usually referred to as `upstream`:
|
||||
|
||||
$ cd gnss-sdr
|
||||
$ git remote add upstream https://github.com/gnss-sdr/gnss-sdr.git
|
||||
$ cd gnss-sdr
|
||||
$ git remote add upstream https://github.com/gnss-sdr/gnss-sdr.git
|
||||
|
||||
To verify the new upstream repository you have specified for your fork,
|
||||
type `git remote -v`. You should see the URL for your fork as `origin`,
|
||||
and the URL for the original repository as `upstream`:
|
||||
To verify the new upstream repository you have specified for your fork, type
|
||||
`git remote -v`. You should see the URL for your fork as `origin`, and the URL
|
||||
for the original repository as `upstream`:
|
||||
|
||||
```
|
||||
$ git remote -v
|
||||
|
|
@ -102,33 +100,32 @@ upstream https://github.com/gnss-sdr/gnss-sdr.git (push)
|
|||
|
||||
### Start working on your contribution
|
||||
|
||||
Checkout the `next` branch of the git repository in order to get
|
||||
synchronized with the latest development code:
|
||||
Checkout the `next` branch of the git repository in order to get synchronized
|
||||
with the latest development code:
|
||||
|
||||
```
|
||||
$ git checkout next
|
||||
$ git pull upstream next
|
||||
```
|
||||
|
||||
When start working in a new improvement, please **always** branch off
|
||||
from `next`. Open a new branch and start working on it:
|
||||
When start working in a new improvement, please **always** branch off from
|
||||
`next`. Open a new branch and start working on it:
|
||||
|
||||
```
|
||||
$ git checkout -b my_feature
|
||||
```
|
||||
|
||||
Now you can do changes, add files, do commits (please take a look at
|
||||
[how to write good commit
|
||||
messages](https://chris.beams.io/posts/git-commit/)!) and push them to
|
||||
your repository:
|
||||
[how to write good commit messages](https://chris.beams.io/posts/git-commit/)!)
|
||||
and push them to your repository:
|
||||
|
||||
```
|
||||
$ git push origin my_feature
|
||||
```
|
||||
|
||||
If there have been new pushes to the `next` branch of the `upstream`
|
||||
repository since the last time you pulled from it, you might want to put
|
||||
your commits on top of them (this is mandatory for pull requests):
|
||||
If there have been new pushes to the `next` branch of the `upstream` repository
|
||||
since the last time you pulled from it, you might want to put your commits on
|
||||
top of them (this is mandatory for pull requests):
|
||||
|
||||
```
|
||||
$ git pull --rebase upstream next
|
||||
|
|
@ -136,55 +133,51 @@ $ git pull --rebase upstream next
|
|||
|
||||
### 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
|
||||
request](https://github.com/gnss-sdr/gnss-sdr/compare/). Head to your
|
||||
GitHub repository, switch to your `my_feature` branch, and click the
|
||||
_**Pull Request**_ button, which will do all the work for you. Code
|
||||
comparison must be always to the `next` branch.
|
||||
When the contribution is ready, you can
|
||||
[submit a pull request](https://github.com/gnss-sdr/gnss-sdr/compare/). Head to
|
||||
your GitHub repository, switch to your `my_feature` branch, and click the
|
||||
_**Pull Request**_ button, which will do all the work for you. Code comparison
|
||||
must be always to the `next` branch.
|
||||
|
||||
Once a pull request is sent, the Developer Team can review the set of
|
||||
changes, discuss potential modifications, and even push follow-up
|
||||
commits if necessary.
|
||||
Once a pull request is sent, the Developer Team can review the set of changes,
|
||||
discuss potential modifications, and even push follow-up commits if necessary.
|
||||
|
||||
Some things that will increase the chance that your pull request is
|
||||
accepted:
|
||||
Some things that will increase the chance that your pull request is accepted:
|
||||
|
||||
* Avoid platform-dependent code. If your code require external
|
||||
dependencies, they must be available as packages in [Debian OldStable](https://wiki.debian.org/DebianOldStable).
|
||||
* Write tests.
|
||||
* Follow our [coding style guide](https://gnss-sdr.org/coding-style/).
|
||||
Specifically, please make sure that you have applied
|
||||
[clang-format](https://clang.llvm.org/docs/ClangFormat.html) and
|
||||
[clang-tidy](https://clang.llvm.org/extra/clang-tidy/) to your changes before
|
||||
you do your pull request. Please check the
|
||||
[final recommendations](https://gnss-sdr.org/coding-style/#final-recommendations)
|
||||
for guidelines on how to apply those tools.
|
||||
* Write a descriptive and detailed summary. Please consider that
|
||||
reviewing pull 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/).
|
||||
- Avoid platform-dependent code. If your code require external dependencies,
|
||||
they must be available as packages in
|
||||
[Debian OldStable](https://wiki.debian.org/DebianOldStable).
|
||||
- Write tests.
|
||||
- Follow our [coding style guide](https://gnss-sdr.org/coding-style/).
|
||||
Specifically, please make sure that you have applied
|
||||
[clang-format](https://clang.llvm.org/docs/ClangFormat.html) and
|
||||
[clang-tidy](https://clang.llvm.org/extra/clang-tidy/) to your changes before
|
||||
you do your pull request. Please check the
|
||||
[final recommendations](https://gnss-sdr.org/coding-style/#final-recommendations)
|
||||
for guidelines on how to apply those tools.
|
||||
- Write a descriptive and detailed summary. Please consider that reviewing pull
|
||||
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/).
|
||||
|
||||
## Contributing to the website
|
||||
|
||||
The content of https://gnss-sdr.org lives in a GitHub repository at
|
||||
https://github.com/gnss-sdr/geniuss-place
|
||||
|
||||
You can fork that repository, reproduce the entire website on your
|
||||
computer using [Jekyll](https://jekyllrb.com/), do changes and submit
|
||||
pull requests, just as explained above. For more details, please check
|
||||
out [how to contribute](https://gnss-sdr.org/contribute/).
|
||||
You can fork that repository, reproduce the entire website on your computer
|
||||
using [Jekyll](https://jekyllrb.com/), do changes and submit pull requests, just
|
||||
as explained above. For more details, please check out
|
||||
[how to contribute](https://gnss-sdr.org/contribute/).
|
||||
|
||||
Last but not the least, you can leave your comments on the website.
|
||||
|
||||
|
||||
------
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -2,6 +2,7 @@
|
|||
|
||||
[](https://www.gnu.org/licenses/gpl-3.0)
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
[comment]: # (
|
||||
SPDX-License-Identifier: GPL-3.0-or-later
|
||||
)
|
||||
|
|
@ -9,6 +10,7 @@ SPDX-License-Identifier: GPL-3.0-or-later
|
|||
[comment]: # (
|
||||
SPDX-FileCopyrightText: 2011-2020 Carles Fernandez-Prades <carles.fernandez@cttc.es>
|
||||
)
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
**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
|
||||
information about this open source software-defined GNSS receiver.
|
||||
|
||||
|
||||
# How to build GNSS-SDR
|
||||
|
||||
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
|
||||
[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>
|
||||
|
||||
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
|
||||
compile time if they are not detected in your machine.
|
||||
|
||||
|
||||
## Other builds
|
||||
|
||||
- **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/)
|
||||
for instructions.
|
||||
|
||||
|
||||
# Updating GNSS-SDR
|
||||
|
||||
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 Tutorial](https://gnss-sdr.org/docs/tutorials/using-git/ "Using Git").
|
||||
|
||||
|
||||
# Getting started
|
||||
|
||||
1. After building the code, you will find the `gnss-sdr` executable file at
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
# Custom structured data format definitions
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
[comment]: # (
|
||||
SPDX-License-Identifier: GPL-3.0-or-later
|
||||
)
|
||||
|
|
@ -7,9 +8,11 @@ SPDX-License-Identifier: GPL-3.0-or-later
|
|||
[comment]: # (
|
||||
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
|
||||
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.
|
||||
|
||||
From those files, the protocol buffer compiler creates classes that implement
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
# XML Schemas for Assisted GNSS-SDR
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
[comment]: # (
|
||||
SPDX-License-Identifier: GPL-3.0-or-later
|
||||
)
|
||||
|
|
@ -7,6 +8,7 @@ SPDX-License-Identifier: GPL-3.0-or-later
|
|||
[comment]: # (
|
||||
SPDX-FileCopyrightText: 2011-2020 Carles Fernandez-Prades <carles.fernandez@cttc.es>
|
||||
)
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
GNSS-SDR can read assistance data from
|
||||
[Extensible Markup Language (XML)](https://www.w3.org/XML/) files for faster
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
[](https://www.gnu.org/licenses/gpl-3.0)
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
[comment]: # (
|
||||
SPDX-License-Identifier: GPL-3.0-or-later
|
||||
)
|
||||
|
|
@ -7,6 +8,7 @@ SPDX-License-Identifier: GPL-3.0-or-later
|
|||
[comment]: # (
|
||||
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
|
||||
|
||||
|
|
@ -47,7 +49,6 @@ baseband processor:
|
|||
|
||||
|
||||
|
||||
## How to build VOLK_GNSSSDR:
|
||||
|
||||
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
|
||||
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 source
|
||||
|
|
|
|||
|
|
@ -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
|
||||
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
|
||||
will install volk_$name.h and libvolk_$name.so.
|
||||
The canonical VOLK-GNSSSDR library installs a volk_gnsssdr.h and a
|
||||
libvolk_gnsssdr.so. Your own library will install volk_gnsssdr_$name.h
|
||||
and libvolk_gnsssdr_$name.so.
|
||||
Ya Gronk?
|
||||
Good.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,12 +1,14 @@
|
|||
## Continuous Reproducibility in GNSS Signal Processing
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
[comment]: # (
|
||||
SPDX-License-Identifier: GPL-3.0-or-later
|
||||
)
|
||||
|
||||
[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
|
||||
proposed in:
|
||||
|
|
|
|||
|
|
@ -1,12 +1,14 @@
|
|||
## obsdiff
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
[comment]: # (
|
||||
SPDX-License-Identifier: GPL-3.0-or-later
|
||||
)
|
||||
|
||||
[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
|
||||
observation files.
|
||||
|
|
@ -94,6 +96,7 @@ boolean flags.
|
|||
|
||||
Available command-line flags:
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
| **Command-line flag** | **Default value** | **Description** |
|
||||
|:-------------------------:|:-----------------:|:-----------------|
|
||||
| `--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) |
|
||||
| `--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. |
|
||||
<!-- prettier-ignore-end -->
|
||||
|
|
|
|||
|
|
@ -1,12 +1,14 @@
|
|||
## Rinex2assist
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
[comment]: # (
|
||||
SPDX-License-Identifier: GPL-3.0-or-later
|
||||
)
|
||||
|
||||
[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
|
||||
can be read by GNSS-SDR as Assisted GNSS data.
|
||||
|
|
|
|||
Loading…
Reference in New Issue