From cc0ab760e16f3d99c14ca478c42c43d3232d1e8c Mon Sep 17 00:00:00 2001 From: philip82148 <92205270+philip82148@users.noreply.github.com> Date: Wed, 27 Sep 2023 14:45:16 +0900 Subject: [PATCH] improve README.md --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index 52f10234..1a2b9df1 100644 --- a/README.md +++ b/README.md @@ -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. @@ -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