Skip to content

Commit

Permalink
Updated README.md with information on tests/profiling
Browse files Browse the repository at this point in the history
  • Loading branch information
geky committed Jul 14, 2016
1 parent dcb356a commit da0e401
Showing 1 changed file with 27 additions and 8 deletions.
35 changes: 27 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,13 +37,32 @@ supports multithreaded environments. More information on the idea
behind composable event loops
[here](https://gist.github.com/geky/4969d940f1bd5596bdc10e79093e2553).
## Porting ##
## Tests ##
The events library uses a set of local tests based on the posix implementation.
Runtime tests are located in [tests.c](tests/tests.c):
``` bash
make test
```

Profiling tests based on rdtsc are located in [prof.c](tests/prof.c):

The events library only requires the following:
- monotonic counter
- non-recursive mutex
- binary semaphore
``` bash
make prof
```

To make profiling results more tangible, the profiler also supports percentage
comparison with previous runs:
``` bash
make prof | tee results.txt
cat results.txt | make prof
```

## Porting ##

Supported implementations are hosted as branches on this repo:
- Posix
- mbed
The events library requires a small porting layer:
- [events_tick](events_tick.h) - monotonic counter
- [events_mutex](events_mutex.h) - non-recursive mutex
- [events_sema](events_sema.h) - binary semaphore

0 comments on commit da0e401

Please sign in to comment.