google/benchmark

Document process for embedding benchmark in external project

Closed

#788 opened on Mar 28, 2019

View on GitHubContributor guide
 (3 comments) (1 reaction) (0 assignees)C++ (1,539 forks)batch import
good first issuehelp wanted

Repository metrics

Stars
 (7,968 stars)
PR merge metrics
 (Avg merge 4d 2h) (19 merged PRs in 30d)

Description

There are a number of Stack Overflow, mailing lists, and IRC enquiries about embedding Benchmark in other projects. Using cmake this should be trivial, but it seems on Windows in particular there are some confusing elements.

Specifically the docs should mention the use of BENCHMARK_DOWNLOAD_DEPENDENCIES, static vs dynamic library generation, vcpkg/installation vs building from head.

Contributor guide

Research direction
Look at the existing documentation in the repository, particularly the README and any docs/ directory. Understand the CMakeLists.txt to see how BENCHMARK DOWNLOAD DEPENDENCIES is used. Check for any existing examples of embedding the library. Then add a new section or file explaining the steps for embedding, covering static vs dynamic linking and vcpkg vs building from source.
Tech stack
cpp
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
basic C++ knowledgefamiliarity with CMake
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75