google/benchmark

Document process for embedding benchmark in external project

Chiusa

#788 aperta il 28 mar 2019

Vedi su GitHubGuida contributor
 (3 commenti) (1 reazione) (0 assegnatari)C++ (1539 fork)batch import
good first issuehelp wanted

Metriche repository

Star
 (7968 stelle)
Metriche merge PR
 (Merge medio 4g 2h) (19 PR mergiate in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
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
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
basic C++ knowledgefamiliarity with CMake
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75