Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update examples documentation #1135

Merged
merged 8 commits into from
Sep 1, 2022
Merged

Update examples documentation #1135

merged 8 commits into from
Sep 1, 2022

Conversation

evgueni-ovtchinnikov
Copy link
Contributor

Changes in this pull request

Updates README.md in example scripts folders and respective wiki pages.

Testing performed

Related issues

Fixes #1134.

Checklist before requesting a review

  • I have performed a self-review of my code
  • I have added docstrings/doxygen in line with the guidance in the developer guide
  • I have implemented unit tests that cover any new or modified functionality
  • The code builds and runs on my machine
  • CHANGES.md has been updated with any functionality change

Contribution Notes

Please read and adhere to the contribution guidelines.

Please tick the following:

  • The content of this Pull Request (the Contribution) is intentionally submitted for inclusion in SIRF (the Work) under the terms and conditions of the Apache-2.0 License.

@KrisThielemans
Copy link
Member

Thanks! I've made some changes by moving things around a bit, and cross-referencing.

I've moved the note on Windows paths (\ vs /) to the main README, but currently commented out, as I don't know if that's still the case.

I guess you'll complete the list of descriptions of each demo?

@KrisThielemans KrisThielemans marked this pull request as ready for review September 1, 2022 08:55
@KrisThielemans KrisThielemans merged commit ed49f3e into master Sep 1, 2022
@KrisThielemans KrisThielemans deleted the readme-update branch September 1, 2022 08:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

update examples documentation
2 participants