Skip to content

Commit

Permalink
improve README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
philip82148 committed Sep 27, 2023
1 parent 6751f47 commit cc0ab76
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,20 @@
# cpp-dump

[日本語記事はこちら!](https://zenn.dev/sassan/articles/19db660e4da0a4)

## Overview

cpp-dump is an all-round dump function library for C++ that supports even user-defined classes.

This library has the following features:

- 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.
- Automatically indents so that the output fits into the maximum line width.
- Header-only library, no build or dependencies required.
- The macro version can dump variables along with the names.
- User-defined types can also be dumped by using macros.
- The string representation of variables is similar to JavaScript, Python and C syntax.

## Introduction

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

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

## Requirement

- C++17 or higher.
- No build or dependencies are required since cpp-dump is a header-only library.

## Installation

```shell
Expand Down

0 comments on commit cc0ab76

Please sign in to comment.