README.md

   1 # vine
   2
   3 ### Preparing to Build (Linux, not Tizen)
   4
   5 #### mDNSresponder
   6 DNS-SD is used for network service discovery.
   7 Download mDNresponder tarball in https://opensource.apple.com/tarballs/mDNSResponder/ and install it.
   8 The recommended version for Vine is 878.70.2.
   9
  10 #### libwebsockets
  11 libwebsockets is used for providing client and server.
  12
  13 Vine provides a prebuilt static library for libwebsockets by default.
  14 Please refer to [third-party/prebuilt](./third-party/prebuilt) directory for details.
  15
  16 Otherwise, you can use build libwebsockets manually.
  17 Download libwebsockets tarball in https://github.com/warmcat/libwebsockets/releases and install it.
  18 The recommended version for Vine is 3.2.0 or later.
  19
  20 **NOTE**: Vine uses poll() to handle events. So, You have to set LWS_WITH_EXTERNAL_POLL option.
  21
  22         cmake . -DLWS_WITH_EXTERNAL_POLL=ON
  23
  24 #### googlemock (Optional)
  25 You can build with unit tests.
  26 Unit test codes of vine have a dependency on googlemock.
  27 To build unit tests, you have to prepare the googlemock shared library.
  28
  29 ### Build
  30 You have to tell the build system where libvine.so and vine.h is installed.
  31 Use -DLIB_DIR for libvine.so and -DINCLUDE_DIR for vine.h
  32
  33         cmake . -DLIB_DIR=${LIB_DIR} -DINCLUDE_DIR=${INCLUDE_DIR}
  34
  35 Use WITH_VINE_TEST to build with vine test programs.
  36 You have to tell the build system where the executables (vine-test) is installed.
  37 Use -DBIN_DIR for the executables.
  38
  39         cmake . -DLIB_DIR=${LIB_DIR} -DINCLUDE_DIR=${INCLUDE_DIR} -DBIN_DIR=${BIN_DIR} -DWITH_VINE_TEST
  40
  41 Use WITH_UNITTEST to build with unit tests.
  42
  43         cmake . -DLIB_DIR=${LIB_DIR} -DINCLUDE_DIR=${INCLUDE_DIR} -DWITH_UNITTEST=ON
  44