Skip to content

Commit

Permalink
doc: add readme to tools/expand
Browse files Browse the repository at this point in the history
  • Loading branch information
ToruNiina committed Jun 16, 2024
1 parent fbfdb6a commit 3e2a155
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions tools/expand/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# expand

`expand` is a tool designed to process `#include "..."` directives within a file, generating a single `single_include/toml.hpp` file.

`expand` is optimized specifically for the structure of `toml11`.
It assumes that the argument provided is `include/toml.hpp` and that there are files separated into `fwd/` and `impl/` directories.
Therefore, it is not a general-purpose tool.

## Usage

```console
$ g++-13 -std=c++20 -O2 main.cpp -o expand
$ ./expand ../../include/toml.hpp > ../../single_include/toml.hpp
```

0 comments on commit 3e2a155

Please sign in to comment.