From 0a555818d7b6f47a22ab4dd4b1515f8a6cdce52f Mon Sep 17 00:00:00 2001 From: Victor Zverovich Date: Wed, 5 Jun 2024 07:59:06 -0700 Subject: [PATCH] Usage -> Get Started --- doc/api.md | 2 +- doc/{usage.md => get-started.md} | 6 +++--- support/mkdocs.yml | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) rename doc/{usage.md => get-started.md} (98%) diff --git a/doc/api.md b/doc/api.md index 6015e3ec..b017c50a 100644 --- a/doc/api.md +++ b/doc/api.md @@ -45,7 +45,7 @@ surrounded by braces `{}`. The fields are replaced with formatted arguments in the resulting string. [`fmt::format_string`](#format_string) is a format string which can be implicitly constructed from a string literal or a `constexpr` string and is checked at compile time in C++20. To pass a runtime -format string wrap it in [fmt::runtime](#runtime). +format string wrap it in [`fmt::runtime`](#runtime). *args* is an argument list representing objects to be formatted. diff --git a/doc/usage.md b/doc/get-started.md similarity index 98% rename from doc/usage.md rename to doc/get-started.md index caafd099..585962f8 100644 --- a/doc/usage.md +++ b/doc/get-started.md @@ -1,12 +1,12 @@ -# Usage +# Get Started To use the {fmt} library, add `fmt/core.h`, `fmt/format.h`, `fmt/format-inl.h`, `src/format.cc` and optionally other headers from a [release archive]( https://github.com/fmtlib/fmt/releases/latest) or the [git repository]( https://github.com/fmtlib/fmt) to your project. Alternatively, you can -[build the library with CMake](#building). +build the library with CMake. -## Building the Library {#building} +## Building the Library The included [CMake build script](https://github.com/fmtlib/fmt/blob/master/CMakeLists.txt) can be diff --git a/support/mkdocs.yml b/support/mkdocs.yml index f51ade43..0e2d2314 100644 --- a/support/mkdocs.yml +++ b/support/mkdocs.yml @@ -36,7 +36,7 @@ plugins: default_handler: cxx nav: - Home: index.md - - Usage: usage.md + - Get Started: get-started.md - API: api.md - Syntax: syntax.md