Skip to content
This repository was archived by the owner on Aug 19, 2021. It is now read-only.

Commit da0e401

Browse files
committed
Updated README.md with information on tests/profiling
1 parent dcb356a commit da0e401

File tree

1 file changed

+27
-8
lines changed

1 file changed

+27
-8
lines changed

README.md

Lines changed: 27 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -37,13 +37,32 @@ supports multithreaded environments. More information on the idea
3737
behind composable event loops
3838
[here](https://gist.github.com/geky/4969d940f1bd5596bdc10e79093e2553).
3939
40-
## Porting ##
40+
## Tests ##
41+
42+
The events library uses a set of local tests based on the posix implementation.
43+
44+
Runtime tests are located in [tests.c](tests/tests.c):
45+
46+
``` bash
47+
make test
48+
```
49+
50+
Profiling tests based on rdtsc are located in [prof.c](tests/prof.c):
4151

42-
The events library only requires the following:
43-
- monotonic counter
44-
- non-recursive mutex
45-
- binary semaphore
52+
``` bash
53+
make prof
54+
```
55+
56+
To make profiling results more tangible, the profiler also supports percentage
57+
comparison with previous runs:
58+
``` bash
59+
make prof | tee results.txt
60+
cat results.txt | make prof
61+
```
62+
63+
## Porting ##
4664

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

0 commit comments

Comments
 (0)