move event_base predeclaration higher in the file

[software/libev.git] / README.embed

diff --git a/README.embed b/README.embed
index 28bbe07b75564b43eeaf7409631fe954df67a1e6..2d2b708bfd58645cbe7bd197304956b69a715891 100644 (file)
--- a/README.embed
+++ b/README.embed
@@ -17,11 +17,17 @@ FILESETS
 
     This will automatically include ev.h, too, and should be done in a
     single C source file only to provide the function implementations. To
-    use it, do the same for ev.h in all users:
+    use it, do the same for ev.h in all files wishing to use this API
+    (best done by writing a wrapper around ev.h that you can include
+    instead and where you can put other configuration options):
 
         #define EV_STANDALONE   1
         #include "ev.h"
 
+    Both header files and implementation files can be compiled with a C++
+    compiler (at least, thats a stated goal, and breakage will be treated
+    as a bug).
+
     You need the following files in your source tree, or in a directory
     in your include path (e.g. in libev/ when using -Ilibev):
 
@@ -31,7 +37,7 @@ FILESETS
         ev_wrap.h
         ev_win32.c
 
-        ev_select.c     only when select backend is enabled (which is by default)
+        ev_select.c     only when select backend is enabled (which is is by default)
         ev_poll.c       only when poll backend is enabled (disabled by default)
         ev_epoll.c      only when the epoll backend is enabled (disabled by default)
         ev_kqueue.c     only when the kqueue backend is enabled (disabled by default)
@@ -69,6 +75,12 @@ PREPROCESSOR SYMBOLS
         will also not define any of the structs usually found in "event.h"
         that are not directly supported by libev code alone.
 
+    EV_H
+
+        The name of the ev.h header file used to include it. The default
+        if undefined is <ev.h> in event.h and "ev.h" in ev.c. This can be used
+        to virtually rename the ev.h header file
+
     EV_USE_MONOTONIC
 
         If undefined or defined to be "1", libev will try to detect the