Skip to content

Commit

Permalink
add meson instructions to usage docs
Browse files Browse the repository at this point in the history
  • Loading branch information
fennewald committed Oct 9, 2023
1 parent 130cf54 commit 829c1b4
Showing 1 changed file with 38 additions and 0 deletions.
38 changes: 38 additions & 0 deletions doc/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,44 @@ For ``build2`` newcomers or to get more details and use cases, you can read the
``build2``
`toolchain introduction <https://build2.org/build2-toolchain/doc/build2-toolchain-intro.xhtml>`_.

Usage with meson
================

`Meson's wrapdb <https://mesonbuild.com/Wrapdb-projects.html>` includes a ``fmt``
package, which repackages fmt to be built by meson as a subproject.

**Usage:**

- Install the ``fmt`` subproject from the wrapdb by running

meson wrap install fmt

from the root of your project.

- In your project's ``meson.build`` file, add an entry for the new subproject:

fmt = subproject('fmt')
fmt_dep = fmt.get_variable('fmt_dep')

- Include the new dependency object to link with fmt:

my_build_target = executable('name', 'src/main.cc', dependencies: [fmt_dep])

**Options:**

If desired, ``fmt`` may be built as a static library, or as a headers-only
library.

For a static build, use the following subproject definition:

fmt = subproject('fmt', default_options: 'default_library=static')
fmt_dep = fmt.get_variable('fmt_dep')

For the headers-only version, use:

fmt = subproject('fmt')
fmt_dep = fmt.get_variable('fmt_header_only_dep')

Building the Documentation
==========================

Expand Down

0 comments on commit 829c1b4

Please sign in to comment.