mirror/fmt
1
0
Fork 0
mirror of https://github.com/fmtlib/fmt.git synced 2025-04-16 05:42:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve docs

Browse Source
This commit is contained in:
Victor Zverovich 2024-06-09 10:47:32 -07:00
parent 72928661ed
commit fcb6a452d6
1 changed files with 14 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
doc/get-started.md
View File

@ -1,22 +1,22 @@
# Get Started # Get Started
You can compile and run {fmt} examples online with [Compiler Explorer]( Compile and run {fmt} examples online with [Compiler Explorer](
https://godbolt.org/z/P7h6cd6o3). https://godbolt.org/z/P7h6cd6o3).
{fmt} can be used with any build system. The next section describes usage with {fmt} is compatible with any build system. The next section describes its usage
CMake, and [Build Systems](#build-systems) covers the rest. with CMake, while the [Build Systems](#build-systems) section covers the rest.
## CMake ## CMake
{fmt} provides two CMake targets: `fmt::fmt` for the compiled library and {fmt} provides two CMake targets: `fmt::fmt` for the compiled library and
`fmt::fmt-header-only` for the header-only library. It is recommended to use `fmt::fmt-header-only` for the header-only library. It is recommended to use
the compiled library for better build times. the compiled library for improved build times.
There are three main ways to consume {fmt} from CMake: There are three primary ways to use {fmt} with CMake:
* **FetchContent**: Since CMake v3.11, [`FetchContent`]( * **FetchContent**: Starting from CMake 3.11, you can use [`FetchContent`](
https://cmake.org/cmake/help/v3.30/module/FetchContent.html) can be used to https://cmake.org/cmake/help/v3.30/module/FetchContent.html) to automatically
automatically download {fmt} as a dependency at configure time: download {fmt} as a dependency at configure time:
include(FetchContent) include(FetchContent)
@ -44,29 +44,28 @@ There are three main ways to consume {fmt} from CMake:
### Debian/Ubuntu ### Debian/Ubuntu
Use the following command to install {fmt} on Debian, Ubuntu, or any other To install {fmt} on Debian, Ubuntu, or any other Debian-based Linux
Debian-based Linux distribution: distribution, use the following command:
apt install libfmt-dev apt install libfmt-dev
### Homebrew ### Homebrew
{fmt} can be installed on macOS using [Homebrew](https://brew.sh/): Install {fmt} on macOS using [Homebrew](https://brew.sh/):
brew install fmt brew install fmt
### Conda ### Conda
{fmt} can be installed on Linux, macOS, and Windows with [Conda]( Install {fmt} on Linux, macOS, and Windows with [Conda](
https://docs.conda.io/en/latest/), using its [conda-forge package]( https://docs.conda.io/en/latest/), using its [conda-forge package](
https://github.com/conda-forge/fmt-feedstock): https://github.com/conda-forge/fmt-feedstock):
conda install -c conda-forge fmt conda install -c conda-forge fmt
### Vcpkg ### vcpkg
You can download and install {fmt} using the [vcpkg]( Download and install {fmt} using the vcpkg package manager:
https://github.com/Microsoft/vcpkg) package manager:
git clone https://github.com/Microsoft/vcpkg.git git clone https://github.com/Microsoft/vcpkg.git
cd vcpkg cd vcpkg