Skip to content

Commit 3213003

Browse files
committed
docs: Clarified dependencies.
1 parent 03bfbe3 commit 3213003

File tree

2 files changed

+19
-4
lines changed

2 files changed

+19
-4
lines changed

BUILD.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,26 @@ This page describes how to build this project.
55
Also make sure to read the page on
66
[integrating this library into your project](DEPENDENCY.md).
77

8-
## Pre-requisites
8+
## Pre-requisites and dependencies
99

1010
* Rust 1.61 or newer (get it from [https://rustup.rs/](https://rustup.rs/))
11-
* A modern C11/C++17 compiler.
11+
* A modern C11 or C++17 compiler.
1212
* CMake 3.15 or newer.
1313

14+
The library statically links all its dependencies.
15+
16+
```
17+
$ ls build/libquestdb_client.*
18+
build/libquestdb_client.a build/libquestdb_client.so
19+
$ ldd build/libquestdb_client.so
20+
linux-vdso.so.1 (0x00007ffddd344000)
21+
libgcc_s.so.1 => /lib/x86_64-linux-gnu/libgcc_s.so.1 (0x00007fe61d252000)
22+
libpthread.so.0 => /lib/x86_64-linux-gnu/libpthread.so.0 (0x00007fe61d22f000)
23+
libdl.so.2 => /lib/x86_64-linux-gnu/libdl.so.2 (0x00007fe61d229000)
24+
libc.so.6 => /lib/x86_64-linux-gnu/libc.so.6 (0x00007fe61d037000)
25+
/lib64/ld-linux-x86-64.so.2 (0x00007fe61d2ee000)
26+
```
27+
1428
## Build steps
1529

1630
### Linux / MacOS

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,12 @@ This library makes it easy to insert data into [QuestDB](https://questdb.io/).
66
This client library implements the [InfluxDB Line Protocol](
77
https://questdb.io/docs/reference/api/ilp/overview/) (ILP) over TCP.
88

9-
* Implementation is in Rust, with no additional run-time or link-time dependency
9+
* Implementation is in Rust, with no additional
10+
[run-time or link-time dependencies](BUILD.md#pre-requisites-and-dependencies)
1011
on the C++ standard library or other libraries.
1112
* We ship both a static and a dynamic library.
1213
* The library exposes both a C and a C++17 API.
13-
* The C++ API is a header-only wrapper written in C++17.
14+
* The C++ API is a header-only wrapper over the C API.
1415

1516
## Protocol
1617

0 commit comments

Comments
 (0)