From f3de2dbaf657f9040a4da448c57267de0fef7d33 Mon Sep 17 00:00:00 2001
From: Julian Andres Klode <jak@debian.org>
Date: Sat, 6 Aug 2016 21:03:43 +0200
Subject: CMake: Add basic CMake build system

Introduce an initial CMake buildsystem. This build system can build
a fully working apt system without translation or documentation.

The FindBerkelyDB module is from kdelibs, with some small adjustements
to also look in db5 directories.

Initial work on this CMake build system started in 2009, and was
resumed in August 2016.
---
 README.cmake | 36 ++++++++++++++++++++++++++++++++++++
 1 file changed, 36 insertions(+)
 create mode 100644 README.cmake

(limited to 'README.cmake')

diff --git a/README.cmake b/README.cmake
new file mode 100644
index 000000000..c9347a057
--- /dev/null
+++ b/README.cmake
@@ -0,0 +1,36 @@
+The Make System
+================
+
+To compile this program using cmake you require cmake 3.3 or newer.
+
+Building
+--------
+The recommended way is to generate a build directory and build in it, e.g.
+
+    mkdir build
+    cd build
+    cmake ..        OR cmake -G Ninja ..
+    make -j4        OR ninja
+
+You can use either the make or the ninja generator; the ninja stuff is faster,
+though. You can also build in-tree:
+
+    cmake -G Ninja
+    ninja
+
+To build a subdirectory; for example, apt-pkg, use one of:
+
+    ninja apt-pkg/all
+    make -C apt-pkg -j4    (or cd apt-pkg && make -j4)
+
+Ninja automatically parallelizes, make needs an explicit -j switch. The travis
+system uses the make generator, the packaging as well.
+
+TODO
+----
+
+The following features have not been implemented yet:
+
+ - documentation
+ - translation
+ - unit tests
-- 
cgit v1.2.3