This is an automated email from the ASF dual-hosted git repository.
pnoltes pushed a commit to branch feature/99-update-documentation
in repository https://gitbox.apache.org/repos/asf/celix.git
commit d1b14e4112dc39055be8bf0352bc75f40492be3e
Author: Pepijn Noltes <pepijnnol...@gmail.com>
AuthorDate: Sun Sep 10 14:07:17 2023 +0200
#99: Add conan info to building documentation
---
documents/building/README.md | 47 ++++++++++++++++++++++++++++++++++++++++++--
1 file changed, 45 insertions(+), 2 deletions(-)
diff --git a/documents/building/README.md b/documents/building/README.md
index 5a9aa530..1b5e2da5 100644
--- a/documents/building/README.md
+++ b/documents/building/README.md
@@ -40,9 +40,10 @@ git clone --single-branch --branch master
https://github.com/apache/celix.git
```
## Building and installing
-Apache Celix uses [CMake](https://cmake.org) as build system. CMake can
generate (among others) makefiles.
+Apache Celix can be build using [Conan](https://conan.io) as package
manager/build system or by directly using
+[CMake](https://cmake.org).
-### Building and installing with preinstalled libraries
+### Building Apache Celix using Conan
The following packages (libraries + headers) should be installed on your
system:
* Development Environment
@@ -50,6 +51,48 @@ The following packages (libraries + headers) should be
installed on your system:
* java or zip (for packaging bundles)
* make (3.14 or higher)
* git
+ * cmake (3.18 or higher)
+ * Conan (2 or higher)
+
+For Ubuntu 20.04, use the following commands:
+```bash
+sudo apt-get install -yq --no-install-recommends \
+ build-essential \
+ git \
+ default-jdk \
+ python3 \
+ python3-pip
+
+#The cmake version for Ubuntu 20 is older than 3.14,
+#use snap to install the latest cmake version
+snap install cmake
+
+#Install conan
+pip3 install -U conan
+```
+
+Configure conan default profile using automatic detection of the system
+```bash
+conan profile detect
+```
+
+Create Apache Celix package - and build the dependencies - in the Conan cache:
+```bash
+cd <celix_source_dir>
+conan create . --output-folder build --build missing -o build_all=True
+```
+
+Note installing Apache Celix is not required when using Conan, because Conan
will install the Apache Celix package
+in the local Conan cache.
+
+### Building Apache Celix directly using CMake
+The following packages (libraries + headers) should be installed on your
system:
+
+* Development Environment
+ * build-essentials (gcc/g++ or clang/clang++)
+ * java or zip (for packaging bundles)
+ * make (3.18 or higher)
+ * git
* Apache Celix Dependencies
* libzip
* uuid
