summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2017-10-13 11:44:44 -0700
committerGarrett D'Amore <garrett@damore.org>2017-10-13 11:44:44 -0700
commit2de033af7edafd037ec55584c4c9bf30dfb949c3 (patch)
treedbb23a625ead1111071479f4305ab307753a813f
parent65c659b278668bad61b54e993cb348a083a0c9ca (diff)
downloadnanomsg-2de033af7edafd037ec55584c4c9bf30dfb949c3.tar.gz
More clear information about static libraries.
-rw-r--r--README.md20
1 files changed, 15 insertions, 5 deletions
diff --git a/README.md b/README.md
index 3f7ffd0..9a3f688 100644
--- a/README.md
+++ b/README.md
@@ -56,13 +56,15 @@ The list of generators supported can be obtained using `cmake --help`.)
*NB:* This may have to be done as a privileged user.
9. (Linux only). `ldconfig` (As a privileged or root user.)
-Static Library (Windows Only)
------------------------------
+Static Library
+--------------
-We normally build a dynamic library (.DLL) by default.
+We normally build a dynamic library (.so or .DLL) by default.
-If you want a static library (.LIB) , configure by passing `-DNN_STATIC_LIB=ON`
-to the `cmake` command.
+If you want a static library (.a or .LIB), configure by passing
+`-DNN_STATIC_LIB=ON` to the `cmake` command.
+
+### Windows
You will also need to define `NN_STATIC_LIB` in your compilation environment
when building programs that use this library.
@@ -70,6 +72,14 @@ when building programs that use this library.
This is required because of the way Windows DLL exports happen. This is not
necessary when compiling on POSIX platforms.
+When using the static library on Windows, you will also need to link with the
+ws2_32, mswsock, and advapi32 libraries, as nanomsg depends on them.
+
+### POSIX
+
+POSIX systems will need to link with the libraries normally used when building
+network applications. For some systems this might mean -lnsl or -lsocket.
+
Resources
---------