Skip to content

simple corrections in README.md #1

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

Open
PTaylor-us wants to merge 1 commit into
base: master
Choose a base branch
from
Open

simple corrections in README.md #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ YouTube video from [embo++ 2018](https://www.embo.io/) describing the inner work

In the `example` folder a few example projects are setup for the NUCLEO-F411RE board. For example:

* A program that will blink a LED every one seconds using `crect` primitives.
* A program that will blink a LED every one second using `crect` primitives.
* An example for how to use `unique_lock` with a data pumping peripheral (for example DMA or a communication interface).

It also contains examples of `crect_system_config.hpp` and `crect_user_config.hpp`, providing references until a documentation is available.
Expand Down Expand Up @@ -126,10 +126,10 @@ using J1 = crect::job<
R1, crect::Rasync // List of possible resource claims
>;
```
Each job need to be added to the `user_job_list< Jobs... >` in `crect_user_config.hpp`.
Each job needs to be added to the `user_job_list< Jobs... >` in `crect_user_config.hpp`.

#### ISR definition
The ISR definitions available are split in the Peripheral ISRs (I >= 0), and System ISRs (I < 0).
The ISR definitions available are split into the Peripheral ISRs (I >= 0), and System ISRs (I < 0).
```C++
// Peripheral ISR definition (I >= 0)
template <crect::details::isr_function_pointer<P, int I>
Expand Down Expand Up @@ -194,7 +194,6 @@ For a full example please see `./examples/unique`.
```C++
```

There is no `unlock`, this is by design.
#### pend / clear
`pend` directly sets a job for execution and will be as soon as its priority is the highest, while `clear` removes the job for execution.
```C++
Expand All @@ -208,7 +207,7 @@ crect::clear(JobToPend_ISR_ID);
```

#### async
Async defers a jobs execution to some specific time.
Async defers a job's execution to some specific time.
```C++
// Using chrono to relate the system to time, the current max time is somewhere around 1500 years, depending on MCU :)
using namespace std::chrono_literals;
Expand Down