Mailing-List: contact commits-help@celix.apache.org; run by ezmlm
Precedence: bulk
Reply-To: dev@celix.apache.org
Content-Type: text/plain; charset="us-ascii"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
From: pnoltes@apache.org
To: commits@celix.apache.org
Date: Thu, 26 Jan 2017 18:12:59 -0000
Message-Id: <577b743f70f249acb43e3fb228707b61@git.apache.org>
In-Reply-To: <2e23ead6cf884719ba27d2bda6a02aca@git.apache.org>
References: <2e23ead6cf884719ba27d2bda6a02aca@git.apache.org>
Subject: [2/2] celix git commit: CELIX-385: Added README for etcdlib
archived-at: Thu, 26 Jan 2017 18:13:00 -0000

CELIX-385: Added README for etcdlib


Project: http://git-wip-us.apache.org/repos/asf/celix/repo
Commit: http://git-wip-us.apache.org/repos/asf/celix/commit/4e665476
Tree: http://git-wip-us.apache.org/repos/asf/celix/tree/4e665476
Diff: http://git-wip-us.apache.org/repos/asf/celix/diff/4e665476

Branch: refs/heads/develop
Commit: 4e665476c2bf1af7f546efc47a5c366498263a62
Parents: e9528c6
Author: Roy Lenferink <lenferinkroy@gmail.com>
Authored: Thu Jan 26 10:52:11 2017 +0100
Committer: Roy Lenferink <lenferinkroy@gmail.com>
Committed: Thu Jan 26 11:24:59 2017 +0100

----------------------------------------------------------------------
 etcdlib/README.md | 71 ++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 71 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/celix/blob/4e665476/etcdlib/README.md
----------------------------------------------------------------------
diff --git a/etcdlib/README.md b/etcdlib/README.md
new file mode 100644
index 0000000..1bbf14e
--- /dev/null
+++ b/etcdlib/README.md
@@ -0,0 +1,71 @@
+#Etcdlib
+etcd is a distributed, consistent key-value store for shared configuration and service discovery, part of the CoreOS project.
+
+This repository provides a library for etcd for C applications.
+
+Etcdlib can be used as part of Celix but is also useable stand-alone.
+
+##Preparing
+The following packages (libraries + headers) should be installed on your system:
+
+*	Development Environment
+	*	build-essentials (gcc/g++ or clang/clang++)
+	*	cmake (3.2 or higher)
+
+* 	Etcdlib Dependencies
+	*	curl
+	*	jansson
+
+##Download the Apache Celix sources
+To get started you first have to download the Apache Celix sources. This can be done by cloning the Apache Celix git repository:
+
+```bash
+#Create a new workspace to work in, e.g:
+mkdir -p ${HOME}/workspace
+export WS=${HOME}/workspace
+cd ${WS}
+
+#clone the repro
+git clone --single-branch --branch develop https://github.com/apache/celix.git
+```
+
+##Building
+Etcdlib uses [CMake](https://cmake.org) as build system. CMake can generate (among others) makefiles or ninja build files. Using ninja build files will result in a faster build.
+
+###Building using CMake and makefiles:
+```bash
+cd ${WS}/celix/etcdlib
+mkdir build
+cd build
+cmake .. 
+make 
+```
+
+###Building using CMake and Ninja
+```bash
+cd ${WS}/celix/etcdlib
+mkdir build
+cd build
+cmake -G Ninja ..
+ninja
+```
+
+##Editing Build options
+With use of CMake, Etcdlib makes it possible to edit build options. This enabled users, among other options, to configure a install location.
+To edit the options use ccmake or cmake-gui. For cmake-gui an additional package install can be necessary (Fedora: `dnf install cmake-gui`). 
+
+```bash
+cd ${WS}/celix/etcdlib/build
+ccmake .
+#Edit the CMAKE_INSTALL_PREFIX config to set the install location
+```
+
+For this guide we assume the CMAKE_INSTALL_PREFIX is `/usr/local`.
+
+##Installing Etcdlib
+
+```bash
+cd ${WS}/celix/etcdlib/build
+make
+sudo make install
+```