Skip to content

Commit f9ed89a

Browse files
committed
Minor clarifications
1 parent 166ab0c commit f9ed89a

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,16 @@ It can be used with pure **C**, although some features using **C++** optionally
55

66
Its 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
912
Use the CallstackLibrary for creating human-readable callstacks and for creating C++ exceptions that can print their
1013
stacktrace.
1114

15+
Either [download a release here][1] and use the prebuilt library and the headers.
16+
17+
Alternatively easily build it yourself:
1218
1. Clone the repository: `git clone --recursive https://github.com/mhahnFr/CallstackLibrary.git`
1319
2. Build it: `cd CallstackLibrary && make`
1420
3. 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
2228
Get started by either downloading a prebuilt version of this library [here][1].
29+
2330
Alternatively you can also build it from source:
2431
1. Clone the repository: `git clone --recursive https://github.com/mhahnFr/CallstackLibrary.git`
2532
2. 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
4552
More 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
4957
make INSTALL_PATH=/usr/local install
5058
```

0 commit comments

Comments
 (0)