[apt.git] / README.cmake

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:

 - Translated docbook guides
 - unit tests
Commit	Line	Data
f3de2dba JAK	1	The Make System
	2	================
	3
	4	To compile this program using cmake you require cmake 3.3 or newer.
	5
	6	Building
	7	--------
	8	The recommended way is to generate a build directory and build in it, e.g.
	9
	10	mkdir build
	11	cd build
	12	cmake .. OR cmake -G Ninja ..
	13	make -j4 OR ninja
	14
	15	You can use either the make or the ninja generator; the ninja stuff is faster,
	16	though. You can also build in-tree:
	17
	18	cmake -G Ninja
	19	ninja
	20
	21	To build a subdirectory; for example, apt-pkg, use one of:
	22
	23	ninja apt-pkg/all
	24	make -C apt-pkg -j4 (or cd apt-pkg && make -j4)
	25
	26	Ninja automatically parallelizes, make needs an explicit -j switch. The travis
	27	system uses the make generator, the packaging as well.
	28
	29	TODO
	30	----
	31
	32	The following features have not been implemented yet:
	33
7def2482	34	- Translated docbook guides
f3de2dba	35	- unit tests