From 3c655b70d965c80e51279d1ba67ff19da130733a Mon Sep 17 00:00:00 2001 From: Patrick Servello Date: Sat, 9 Feb 2019 10:28:01 -0600 Subject: [PATCH] Added single header file information to the README --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index d915fee..e50b23f 100644 --- a/README.md +++ b/README.md @@ -181,6 +181,12 @@ using mmap_sink = mio::basic_mmap_sink; Though generally not needed, since mio maps users requested offsets to page boundaries, you can query the underlying system's page allocation granularity by invoking `mio::page_size()`, which is located in `mio/page.hpp`. +### Single Header File +Mio can be added to your project as a single header file simply by including `\single_include\mio\mio.hpp`. Single header files can be regenerated at any time by running the `amalgamate.py` script within `\third_party`. +``` +python amalgamate.py -c config.json -s ../include +``` + ## CMake As a header-only library, mio has no compiled components. Nevertheless, a [CMake](https://cmake.org/overview/) build system is provided to allow easy testing, installation, and subproject composition on many platforms and operating systems. @@ -328,3 +334,4 @@ target_link_libraries( MyTarget PUBLIC ) ``` Note that, as a subproject, mio's tests and examples will not be built and CPack integration is deferred to the host project. +