@@ -5,10 +5,16 @@ It can be used with pure **C**, although some features using **C++** optionally
55
66Its API is available for both ** C** and ** C++** .
77
8+ This stacktrace library is designed to be fast and to have almost no dependencies, with the notable exception being the
9+ usually preinstalled ` libexecinfo ` (for the function ` backtrace ` ).
10+
811## Quickstart
912Use the CallstackLibrary for creating human-readable callstacks and for creating C++ exceptions that can print their
1013stacktrace.
1114
15+ Either [ download a release here] [ 1 ] and use the prebuilt library and the headers.
16+
17+ Alternatively easily build it yourself:
12181 . Clone the repository: ` git clone --recursive https://github.com/mhahnFr/CallstackLibrary.git `
13192 . Build it: ` cd CallstackLibrary && make `
14203 . Link your code with ` -L<path/to/library> -lcallstack `
@@ -20,6 +26,7 @@ More explanation can be found in the [wiki][3]; the detailed explanation follows
2026## Usage
2127### Installation
2228Get started by either downloading a prebuilt version of this library [ here] [ 1 ] .
29+
2330Alternatively you can also build it from source:
24311 . Clone the repository: ` git clone --recursive https://github.com/mhahnFr/CallstackLibrary.git `
25322 . go into the cloned repository: ` cd CallstackLibrary `
@@ -44,7 +51,8 @@ To enable the optional **C++** exclusive functions add `CXX_FUNCTIONS=true` as a
4451
4552More information about the ** C++** exclusive functions [here][6].
4653
47- Once you have a copy of the CallstackLibrary you can install it using the following command:
54+ If you want to install the library, which is * not* necessary for it to work properly, you can do so using the
55+ following command:
4856` ` ` shell
4957make INSTALL_PATH=/usr/local install
5058` ` `
0 commit comments