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.

Sign up for GitHub

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

Jump to bottom

Adding documentation. #57

Merged
merged 10 commits into from
Jun 8, 2022
Merged

Adding documentation. #57

merged 10 commits into from
Jun 8, 2022

Commits on Jun 8, 2022

  1. Adding documentation for threading basics.

    @aentinger
    aentinger committed Jun 8, 2022
    Configuration menu
    Copy the full SHA
    21941aa View commit details
    Browse the repository at this point in the history

  2. Adding documentation for Shared/Sink/Source semantics.

    @aentinger
    aentinger committed Jun 8, 2022
    Configuration menu
    Copy the full SHA
    84a9e97 View commit details
    Browse the repository at this point in the history

  3. Adding documentation for threadsafe Serial.

    @aentinger
    aentinger committed Jun 8, 2022
    Configuration menu
    Copy the full SHA
    58d7591 View commit details
    Browse the repository at this point in the history

  4. Adding documentation for threadsafe Wire.

    @aentinger
    aentinger committed Jun 8, 2022
    Configuration menu
    Copy the full SHA
    a6906ec View commit details
    Browse the repository at this point in the history

  5. Adding download link for multi-threading supporting arduino-cli.

    @aentinger
    aentinger committed Jun 8, 2022
    Configuration menu
    Copy the full SHA
    e929157 View commit details
    Browse the repository at this point in the history

  6. Adding documentation for threadsafe SPI.

    @aentinger
    aentinger committed Jun 8, 2022
    Configuration menu
    Copy the full SHA
    22ab392 View commit details
    Browse the repository at this point in the history

  7. Adding download links for all platforms.

    @aentinger
    aentinger committed Jun 8, 2022
    Configuration menu
    Copy the full SHA
    b1f3517 View commit details
    Browse the repository at this point in the history

  8. Fix: a arduino sketch can contain multiple ino-files, not just a sing… 

    …le one.

(But you can only define setup/loop once.
See #57 (comment).
    @aentinger
    aentinger committed Jun 8, 2022
    Configuration menu
    Copy the full SHA
    7ea808b View commit details
    Browse the repository at this point in the history

  9. Adding information on limitation of inot-file names.

    @aentinger
    aentinger committed Jun 8, 2022
    Configuration menu
    Copy the full SHA
    7976e7e View commit details
    Browse the repository at this point in the history

  10. Documentation suggestions (#59) 

    * Add questions and suggestions to main readme

* Add questions and suggestions to the main docs readme

* Add numbers to toc

* Add introduction about single-thread limitations

* Add reference to example

* Add Caveats section

* Rephrase benefits paragraph

* Add note about single threaded example

* Add question about multi core

* Perform minor rewording

* Add recommendation for naming

* Add questions, comments and rephrasing to data exchange

* Add note about hierarchy graphic

* Add rephrasings and questions to Thread-safe serial

* Add rewording and questions to threadsafe wire

* Add questions, comments and rephrasing to threadsafe SPI

* Clarify on comment

* Explain threading and blocking

* Remove questions

* Update docs/01-threading-basics.md

Co-authored-by: Alexander Entinger <consulting@lxrobotics.com>

* Update docs/01-threading-basics.md

Co-authored-by: Alexander Entinger <consulting@lxrobotics.com>

* Update docs/01-threading-basics.md

Co-authored-by: Alexander Entinger <consulting@lxrobotics.com>

* Update README.md

Co-authored-by: Alexander Entinger <consulting@lxrobotics.com>

* Update docs/01-threading-basics.md

Co-authored-by: Alexander Entinger <consulting@lxrobotics.com>

* Update docs/02-data-exchange.md

Co-authored-by: Alexander Entinger <consulting@lxrobotics.com>

* Update docs/02-data-exchange.md

Co-authored-by: Alexander Entinger <consulting@lxrobotics.com>

* Update docs/02-data-exchange.md

Co-authored-by: Alexander Entinger <consulting@lxrobotics.com>

* Update docs/02-data-exchange.md

Co-authored-by: Alexander Entinger <consulting@lxrobotics.com>

* Update docs/02-data-exchange.md

Co-authored-by: Alexander Entinger <consulting@lxrobotics.com>

* Update docs/02-data-exchange.md

Co-authored-by: Alexander Entinger <consulting@lxrobotics.com>

* Update docs/02-data-exchange.md

Co-authored-by: Alexander Entinger <consulting@lxrobotics.com>

* Update docs/02-data-exchange.md

Co-authored-by: Alexander Entinger <consulting@lxrobotics.com>

* Update docs/05-threadsafe-spi.md

Co-authored-by: Alexander Entinger <consulting@lxrobotics.com>

* Update docs/04-threadsafe-wire.md

Co-authored-by: Alexander Entinger <consulting@lxrobotics.com>

* Update docs/05-threadsafe-spi.md

Co-authored-by: Alexander Entinger <consulting@lxrobotics.com>

* Update docs/05-threadsafe-spi.md

Co-authored-by: Alexander Entinger <consulting@lxrobotics.com>

* Update docs/05-threadsafe-spi.md

Co-authored-by: Alexander Entinger <consulting@lxrobotics.com>

* Update docs/README.md

Co-authored-by: Alexander Entinger <consulting@lxrobotics.com>

* Update docs/05-threadsafe-spi.md

Co-authored-by: Alexander Entinger <consulting@lxrobotics.com>

* Update docs/01-threading-basics.md

* Update docs/02-data-exchange.md

Co-authored-by: Alexander Entinger <consulting@lxrobotics.com>
    @sebromero @aentinger
    sebromero and aentinger committed Jun 8, 2022
    Configuration menu
    Copy the full SHA
    8721ef7 View commit details
    Browse the repository at this point in the history