google/benchmark

Document process for embedding benchmark in external project

Fermée

#788 ouverte le 28 mars 2019

Voir sur GitHubGuide contributeur
 (3 commentaires) (1 réaction) (0 personne assignée)C++ (1 539 forks)batch import
good first issuehelp wanted

Métriques du dépôt

Stars
 (7 968 étoiles)
Métriques de merge PR
 (Merge moyen 4j 2h) (19 PRs mergées en 30 j)

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.

Guide contributeur

Direction de recherche
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.
Stack technique
cpp
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
basic C++ knowledgefamiliarity with CMake
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75