From 57748973ae70450c5f875f0ca577bbaed305d9ad Mon Sep 17 00:00:00 2001 From: Michael Adam Date: Tue, 27 May 2014 07:57:20 +0200 Subject: Add README.install - instructions for building and installing. Signed-off-by: Michael Adam Reviewed-by: Andreas Schneider --- README.install | 74 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 74 insertions(+) create mode 100644 README.install diff --git a/README.install b/README.install new file mode 100644 index 0000000..e06a951 --- /dev/null +++ b/README.install @@ -0,0 +1,74 @@ +Obtaining the sources +===================== + +Source tarballs for socket_wrapper can be downloaded from + + https://ftp.samba.org/pub/cwrap/ + +The source code repository for socket wrapper is located under + + git://git.samba.org/socket_wrapper.git + +To create a local copy, run + + $ git clone git://git.samba.org/socket_wrapper.git + $ cd socket_wrapper + +Building from sources +===================== + +socket_wrapper uses cmake (www.cmake.org) as build system. + +In a unpacked sources base directory, create a directory to +contain the build results: + + $ mkdir obj + $ cd obj + +Note this target directory can be named arbitrarily. + +Next, run cmake to configure the build, e.g.: + + $ cmake -DCMAKE_INSTALL_PREFIX= .. + +or on a 64 bit red hat system: + + $ cmake -DCMAKE_INSTALL_PREFIX= -DLIB_SUFFIX=64 .. + +The "" should be replaced by the intended installation +target prefix directory, typically /usr or /usr/local. +If the build target directory is no a direct subdirectory +of the source base directory, ".." needs to be replaced +by the relative or absolute path of that directory. + +One can control the build type with "-DCMAKE_BUILD_TYPE=" +where can be one of Debug, Release, RelWithDebInfo, and +some more (see cmake.org). The default is RelWithDebInfo. + +Afterward configuring with cmake, run the build with + + $ make + +Unit testing +============ + +In order to support running the test suite after building, +the cmocka unit test framework needs to be installed (cmocka.org), +and you need to specify + + -DUNIT_TESTING=ON + +in the cmake run. After running "make", + + $ make test + +runs the test suite. + +Installing +========== + +socket_wrapper is installed into the prefix directory +after running "cmake" and "make" with + + $ make install + -- cgit