cmake-examples README

The project's README from github.com/ttroy50/cmake-examples. As one markdown file: README.md.

= CMake Examples :toc: :toc-placement!:

toc::[]

Introduction

https://cmake.org/[CMake] is a cross-platform open-source meta-build system which can build, test and package software. It can be used to support multiple native build environments including make, Apple's xcode and Microsoft Visual Studio.

This repository includes some example modern CMake configurations which I have picked up when exploring it's usage for various projects. The examples are laid out in a tutorial like format. The first examples are very basic and slowly increase in complexity drawing on previous examples to show more complex use cases.

These examples have been tested on Ubuntu 16.04 but should work under any Linux system that supports CMake v3.5+.

This branch works with the CMake version 3.5 onwards.

image:https://travis-ci.org/ttroy50/cmake-examples.svg?branch=master["Build Status", link="https://travis-ci.org/ttroy50/cmake-examples"]

Requirements

The basic requirements for most examples are:

Installation on Ubuntu

The easiest way to install the above on Ubuntu is as follows

[source,bash]

$ sudo apt-get install build-essential $ sudo apt-get install cmake

Some specific examples may require other tools including:

Docker

Docker containers with all requirements and various versions of CMake are generated to help make testing the examples easier. These are available from the docker hub repository link:https://hub.docker.com/r/matrim/cmake-examples/[matrim/cmake-examples].

To build the full set of cmake-examples test cases you can run:

[source,bash]

docker run -it matrim/cmake-examples:3.5.1 cd ~ git clone https://github.com/ttroy50/cmake-examples.git code cd code ./test.sh

For more details on build and running the docker containers link:here[dockerfiles].

Other Links

There are many CMake tutorials and examples online. The list below includes links to some of these which I have found helpful in my CMake journey.

cmake-examples (ttroy50/cmake-examples)

Searching Database…

Что это такое?Учебный репозиторий с примерами проектов на CMake, расположенными от простых к сложным. Он показывает, как использовать современный CMake для сборки, тестирования и упаковки программ на C++.
Это библиотека или набор примеров проектов?Это набор самостоятельных примеров проектов на CMake, каждый в своей папке. Их предназначено читать и запускать как пошаговое руководство, а не подключать как библиотеку.
Как попробовать примеры?Установите CMake и компилятор C++, затем клонируйте репозиторий, выполните cd в любую папку с примером и соберите его. Скрипт «test.sh» также может запустить все примеры внутри предоставленного Docker-контейнера.
Что нужно установить перед сборкой примеров?CMake версии 3.5 или новее, компилятор C++ (по умолчанию gcc) и make. Некоторым отдельным примерам также нужны инструменты вроде Boost, protobuf, cppcheck, clang, ninja-build или conan.
Будут ли эти примеры работать с любой версией CMake?Эта ветка рассчитана на CMake 3.5 и новее. Для примеров, написанных под CMake 2.x и 3.0, существуют отдельные ветки.
Можно ли запускать эти примеры вне Ubuntu/Linux?Их проверяли на Ubuntu 16.04, и они должны работать в любой Linux-системе с CMake v3.5+. Сам CMake кроссплатформенный (поддерживает make, Xcode, Visual Studio), но приведённые инструкции по установке относятся только к Ubuntu.
Какие темы охватывают примеры помимо базовой сборки?Они переходят к тестированию с CTest, Google Test и Catch, упаковке с CPack, статическому анализу с помощью Cppcheck и clang, форматированию кода с clang-format и использованию зависимостей, таких как Boost и Conan.
Есть ли способ проще протестировать все примеры, не устанавливая всё вручную?Да. Docker-образы со всеми требованиями и разными версиями CMake опубликованы на Docker Hub (matrim/cmake-examples), а скрипт test.sh может запустить все примеры внутри контейнера.
Как примеры организованы для новичка?Они начинаются очень просто и постепенно усложняются. Более поздние примеры опираются на концепции из предыдущих, поэтому новичок может проходить их примерно по порядку.
Creator
ttroy50
Size
0.5 MB
Stars
13.1K
Age
10y
Commits · 90 Days