Skip to content

Commit cc0ab76

Browse files
committed
improve README.md
1 parent 6751f47 commit cc0ab76

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,20 @@
11
# cpp-dump
22

3+
[日本語記事はこちら!](https://zenn.dev/sassan/articles/19db660e4da0a4)
4+
5+
## Overview
6+
37
cpp-dump is an all-round dump function library for C++ that supports even user-defined classes.
48

9+
This library has the following features:
10+
11+
- Outputs to the standard error output (std::clog) string representations of a wide variety of types: multidimensional arrays, (multi)maps, (multi)sets, complex numbers, even error objects, and etc.
12+
- Automatically indents so that the output fits into the maximum line width.
13+
- Header-only library, no build or dependencies required.
14+
- The macro version can dump variables along with the names.
15+
- User-defined types can also be dumped by using macros.
16+
- The string representation of variables is similar to JavaScript, Python and C syntax.
17+
518
## Introduction
619

720
cpp-dump has a macro version and a function version of dump functions.
@@ -113,6 +126,11 @@ CPP_DUMP(new_my_enum);
113126

114127
![user-defined-enum.png](./readme/user-defined-enum.png)
115128

129+
## Requirement
130+
131+
- C++17 or higher.
132+
- No build or dependencies are required since cpp-dump is a header-only library.
133+
116134
## Installation
117135

118136
```shell

0 commit comments

Comments
 (0)