Skip to content

Commit 87a717f

Browse files
committed
improve README.md
1 parent 51deae5 commit 87a717f

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -250,7 +250,7 @@ git clone https://github.com/philip82148/cpp-dump
250250
cd cpp-dump
251251
cmake -S . -B build # No configuration is needed because the library is header-only.
252252
sudo cmake --install build
253-
# (The cpp-dump folder can be removed after this.)
253+
# (The 'cpp-dump' folder can be removed after this.)
254254
```
255255

256256
Then
@@ -287,7 +287,7 @@ Then
287287

288288
## Configuration (as needed)
289289

290-
If you want to customize the library, use the `CPP_DUMP_SET_OPTION_GLOBAL()` macro:
290+
If you want to customize the library, you can write the configuration code as follows:
291291

292292
`custom-cpp-dump.hpp`
293293

@@ -296,6 +296,9 @@ If you want to customize the library, use the `CPP_DUMP_SET_OPTION_GLOBAL()` mac
296296
#include "path/to/cpp-dump/cpp-dump.hpp"
297297
namespace cp = cpp_dump;
298298
CPP_DUMP_SET_OPTION_GLOBAL(max_line_width, 100);
299+
300+
// To ensure proper instantiation of templates, it is recommended to include these in header files.
301+
// (These need to be included in at least one translation unit where cpp_dump(...) prints the type.)
299302
// CPP_DUMP_DEFINE_EXPORT_ENUM(...);
300303
// CPP_DUMP_DEFINE_EXPORT_OBJECT(...);
301304
// CPP_DUMP_DEFINE_EXPORT_OBJECT_GENERIC(...);

0 commit comments

Comments
 (0)