From d26cf43b32b4634014132a6dd82e256bef222e23 Mon Sep 17 00:00:00 2001 From: "an.tsouchlos" Date: Wed, 9 Feb 2022 16:48:02 +0000 Subject: [PATCH] Added note about including library in project --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 9415c80..b291ab2 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,14 @@ time then formats the numbers and writes them into their place in the array. Disclaimer: The actual formatting code is largely shamelessly stolen from `fmtlib`. +## Including in a project + +In order to keep it as lightweight and optimizable as possible, `const_fmt` is implemented as a header-only +library. + +This means that including in a project is as simple as cloning this project (or e.g. adding it as a submodule) +and adding the repository root folder to the compile include directories. + ## Building and running the tests 1. Initialize the `googletest` framework submodule