update build instructions

Mon, 18 Dec 2023 14:25:10 +0100

author
Mike Becker <universe@uap-core.de>
date
Mon, 18 Dec 2023 14:25:10 +0100
changeset 760
52e49533e7b4
parent 759
475335643af4
child 761
61d5197d612b

update build instructions

CHANGELOG file | annotate | diff | comparison | revisions
README file | annotate | diff | comparison | revisions
docs/src/install.md file | annotate | diff | comparison | revisions
--- a/CHANGELOG	Mon Dec 18 14:14:47 2023 +0100
+++ b/CHANGELOG	Mon Dec 18 14:25:10 2023 +0100
@@ -1,6 +1,7 @@
 Version 3.1 - tbd.
 ------------------------
 * fix wrong link from UCX 2 documentation to UCX 3 documentation
+* remove CMake, except for tests at the moment, in favor of uwproj
 
 Version 3.0 - 2023-07-09
 ------------------------
--- a/README	Mon Dec 18 14:14:47 2023 +0100
+++ b/README	Mon Dec 18 14:25:10 2023 +0100
@@ -19,27 +19,27 @@
 modules to minimize the library footprint. Using the build files you can create
 a static and a shared lib containing all modules, but you may also use the UCX
 sources in your project and compile specific modules by yourself to further
-minimize the footprint.
+minimize the footprint, e.g. when you need lists, but do not need hash maps.
 
 
 2. Build
 --------
 
-The build processes uses CMake starting with UCX 3.0.
-You can clone the repository or download the sources from SourceForge.
+The build processes requires executing a simple configure script and calling
+make. You can clone the repository or download the sources from SourceForge.
 
     wget https://sourceforge.net/projects/ucx/files/ucx-latest.tar.gz
     tar -xzf ucx-latest.tar.gz
     cd ucx-latest
 
-Then create a build directory and use cmake to create the build files,
-execute the build, and - optionally - install the files.
+Then execute ./configure with the options you like. You can get a list of
+all available options with ./configure --help. The recommended configuration
+for production builds is ./configure --release.
 
-    mkdir build
-    cd build
-    cmake ..
-    cmake --build .
-    sudo cmake --install .
+    ./configure --release
+    make
+    make check                 # only available when built with tests
+    sudo make install
 
 3. Documentation
 ----------------
--- a/docs/src/install.md	Mon Dec 18 14:14:47 2023 +0100
+++ b/docs/src/install.md	Mon Dec 18 14:25:10 2023 +0100
@@ -2,21 +2,21 @@
 title: Build Instructions
 ---
 
-The build processes uses CMake starting with UCX 3.0.
+The build processes uses configure and make.
 First, download the source code from [Source Forge][1].
 
     wget https://sourceforge.net/projects/ucx/files/ucx-latest.tar.gz
     tar -xzf ucx-latest.tar.gz
     cd ucx-latest
-    
-Then create a build directory and use cmake to create the build files,
-execute the build, and - optionally - install the files.
+
+Then execute ./configure with the options you like. You can get a list of
+all available options with ./configure --help. The recommended configuration
+for production builds is ./configure --release.
 
-    mkdir build
-    cd build
-    cmake ..
-    cmake --build .
-    sudo cmake --install .
+    ./configure --release
+    make
+    make check                 # only available when built with tests 
+    sudo make install
 
 When compiling UCX 3, you can tweak the buffer sizes for small-buffer-optimization.
 You can do this, be pre-defining one or more of the following macros:

mercurial