From 2d867703486443d0cc50970481147fa907ec3d73 Mon Sep 17 00:00:00 2001 From: Jeremy <51220084+jeremy-rifkin@users.noreply.github.com> Date: Fri, 14 Jul 2023 18:25:36 -0400 Subject: [PATCH] Update readme --- README.md | 29 ++++++++++++++++++++++++++--- 1 file changed, 26 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 73eac75..3089cc0 100644 --- a/README.md +++ b/README.md @@ -13,16 +13,39 @@ Make stack traces simple for once. Support for cygwin/mingw will be added soon. -*Some day C++23's `` will be ubiquitous, and maybe one day the msvc implementation will be acceptable* +Some day C++23's `` will be ubiquitous. And maybe one day the msvc implementation will be acceptable. ## Table of contents -- [cpptrace](#cpptrace) +- [Cpptrace](#cpptrace) - [Table of contents](#table-of-contents) + - [How to use](#how-to-use) + - [CMake FetchContent](#cmake-fetchcontent) + - [System-wide installation](#system-wide-installation) + - [Conan](#conan) + - [Vcpkg](#vcpkg) - [Docs](#docs) - - [Backends](#backends) + - [Back-ends](#back-ends) - [License](#license) +## How to use + +### CMake FetchContent + +TODO + +### System-wide installation + +TODO + +### Conan + +TODO + +### Vcpkg + +TODO + ## Docs `cpptrace::print_trace()` can be used to print a stacktrace at the current call site, `cpptrace::generate_trace()` can