coffee/wepoll
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: readme tweaks

Browse Source
This commit is contained in:
Bert Belder 2018-05-02 06:50:12 +02:00
parent 564db33b82
commit 1bcd5d35e3
No known key found for this signature in database
GPG Key ID: 7A77887B2E2ED461
1 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -38,21 +38,23 @@ to run on Linux.
## How to use ## How to use
The library is [distributed][dist] as a single source file The library is [distributed][dist] as a single source file
([wepoll.c][wepoll.c]) and a single header file ([wepoll.h][wepoll.h]). ([wepoll.c][wepoll.c]) and a single header file ([wepoll.h][wepoll.h]).<br>
Compile the .c file as part of your project, and include the header Compile the .c file as part of your project, and include the header wherever
wherever needed. needed.
## Compatibility ## Compatibility
* Requires Windows Vista or higher. * Requires Windows Vista or higher.
* Can be compiled with recent versions of MSVC, Clang, and GCC. * Can be compiled with recent versions of MSVC, Clang, and GCC.
## API notes ## API
### General ### General remarks
* The epoll port is a `HANDLE`, not a file descriptor. * The epoll port is a `HANDLE`, not a file descriptor.
* All functions set both `errno` and `GetLastError()` on failure. * All functions set both `errno` and `GetLastError()` on failure.
* For more extensive documentation, see the [epoll(7) man page][man epoll],
and the per-function man pages that are linked below.
### epoll_create/epoll_create1 ### epoll_create/epoll_create1