google/benchmark

Document process for embedding benchmark in external project

Geschlossen

#788 geöffnet am 28.03.2019

Auf GitHub ansehenContributor Guide
 (3 Kommentare) (1 Reaktion) (0 zugewiesene Personen)C++ (1.539 Forks)batch import
good first issuehelp wanted

Repository-Metriken

Stars
 (7.968 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 4T 2h) (19 gemergte PRs in 30 T)

Beschreibung

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-Richtung
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
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
basic C++ knowledgefamiliarity with CMake
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75