Lines Matching +full:build +full:- +full:docs
3 …build-and-test](https://github.com/google/benchmark/workflows/build-and-test/badge.svg)](https://g…
6 …st-bindings](https://github.com/google/benchmark/workflows/test-bindings/badge.svg)](https://githu…
33 [User Guide](docs/user_guide.md) for a more comprehensive feature overview.
35 …read the [Google Test documentation](https://github.com/google/googletest/blob/main/docs/primer.md)
40 [Discussion group](https://groups.google.com/d/forum/benchmark-discuss)
45 [Additional Tooling Documentation](docs/tools.md)
47 [Assembly Testing Documentation](docs/AssemblyTests.md)
49 [Building and installing Python bindings](docs/python_bindings.md)
53 The library can be used with C++03. However, it requires C++14 to build,
56 _See [dependencies.md](docs/dependencies.md) for more details regarding supported
61 See [Platform-Specific Build Instructions](docs/platform_specific_build_instructions.md).
65 This describes the installation process using cmake. As pre-requisites, you'll
68 _See [dependencies.md](docs/dependencies.md) for more details regarding supported
69 versions of build tools._
76 # Make a build directory to place the build output.
77 $ cmake -E make_directory "build"
78 # Generate build system files with cmake, and download any dependencies.
79 $ cmake -E chdir "build" cmake -DBENCHMARK_DOWNLOAD_DEPENDENCIES=on -DCMAKE_BUILD_TYPE=Release ../
81 # cmake -DCMAKE_BUILD_TYPE=Release -S . -B "build"
82 # Build the library.
83 $ cmake --build "build" --config Release
86 On a unix system, the build directory should now look something like this:
90 /build
98 Next, you can run the tests to check the build.
101 $ cmake -E chdir "build" ctest --build-config Release
107 sudo cmake --build "build" --config Release --target install
110 Note that Google Benchmark requires Google Test to build and run the tests. This
114 * Otherwise, if `-DBENCHMARK_DOWNLOAD_DEPENDENCIES=ON` is specified during
115 configuration as above, the library will automatically download and build
118 If you do not wish to build and run the tests, add `-DBENCHMARK_ENABLE_GTEST_TESTS=OFF`
124 output when this is the case. To build it as a release library instead, add
125 `-DCMAKE_BUILD_TYPE=Release` when generating the build system files, as shown
126 above. The use of `--config Release` in build commands is needed to properly
127 support multi-configuration tools (like Visual Studio for example) and can be
128 skipped for other build systems (like Makefile).
130 To enable link-time optimisation, also add `-DBENCHMARK_ENABLE_LTO=true` when
131 generating the build system files.
141 …-DCMAKE_C_FLAGS="-g -O2 -fno-omit-frame-pointer -fsanitize=address -fsanitize=thread -fno-sanitize…
142 …-DCMAKE_CXX_FLAGS="-g -O2 -fno-omit-frame-pointer -fsanitize=address -fsanitize=thread -fno-saniti…
187 (libbenchmark.a/.so). If you followed the build steps above, this library will
188 be under the build directory you created.
191 # Example on linux after running the build steps above. Assumes the
192 # `benchmark` and `build` directories are under the current directory.
193 $ g++ mybenchmark.cc -std=c++11 -isystem benchmark/include \
194 -Lbenchmark/build/src -lbenchmark -lpthread -o mybenchmark
200 The compiled executable will run all benchmarks by default. Pass the `--help`
201 flag for option information or see the [User Guide](docs/user_guide.md).
205 If using CMake, it is recommended to link against the project-provided