evmc/README.md
Paweł Bylica 6ee4682924 Squashed 'cmake/cable/' changes from 5fd6d89..caeabb3
caeabb3 CableBuildInfo: Specify gitinfo.txt byproduct
69a5abc CableBuildInfo: Remove broken debug logs
a5a1829 CableCompilerSettings: Enabled conversion warnings by default
0790aec README: Add section about git subtree
4056c71 Add the project name to every file
612d1b2 Add cxx11-c99 toolchain file

git-subtree-dir: cmake/cable
git-subtree-split: caeabb3a9f054f5c0b5076aa958968c42f7a5df4
2018-05-11 16:58:08 +02:00

2.3 KiB

Cable

readme style: standard

Cable: CMake Bootstrap Library

Cable is a set of CMake modules and scripts containing common patterns used in CMake-based C++ projects. The design goal is to be pragmatic rather than generic so the number of provided options is minimal. The Cable modules are independent and it is easy to use them individually.

Table of Contents

Install

As git subtree

Adding a dependency project as a git subtree is just a copy of the source code done in a bit more systematic way.

If you are not familiar with managing dependencies with git subtree read the Git subtree: the alternative to Git submodule.

git remote add cable https://github.com/ethereum/cable
git subtree add --prefix cmake/cable cable master --squash

As git submodule

Include the Cable library as git submodule in your project. The suggested submodule location is cmake/cable relative to your project root directory.

git submodule add https://github.com/ethereum/cable cmake/cable

Usage

Cable contains the bootstrap.cmake file that initializes the library. Start by including this file in your main CMakeLists.txt from the Cable submodule/subtree or any other location. The bootstrap.cmake must be included before the project() command. After that, you can include and use other Cable modules.

Example

cmake_minimum_required(VERSION 3.5)

include(cmake/cable/bootstrap.cmake)
include(CableBuildType)

project(tothemoon)

cable_set_build_type(DEFAULT RelWithDebInfo CONFIGURATION_TYPES Debug Release RelWithDebInfo)

Maintainer

Paweł Bylica @chfast

License

Licensed under the Apache License, Version 2.0.