Skip to content

Update header for README.md #327

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Oct 11, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 14 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
# WARNING: THIS IS SUPER MEGA EXTRA ALPHA VERSION OF C++ DRIVER FOR YDB!!!
# Don't use it in production environment!
# YDB C++ SDK
## This is a pre-release version of the C++ driver for [YDB](https://github.com/ydb-platform/ydb), backward compatibility is not guaranteed!

If you ok with this warning, then...
## Building YDB C++ SDK from sources

# Building YDB C++ SDK from sources

## Prerequisites
### Prerequisites

- cmake 3.22+
- clang 16+
Expand All @@ -15,7 +13,7 @@ If you ok with this warning, then...
- yasm
- protoc

## Library dependencies
### Library dependencies

- gRPC
- protobuf
Expand All @@ -33,17 +31,17 @@ If you ok with this warning, then...
- double-conversion
- jwt-cpp

## Runtime requirements
### Runtime requirements

- libidn11-dev (IDN)
- libiconv (Iconv)

## Testing requirements
### Testing requirements

- gtest
- gmock

## Install dependencies
### Install dependencies

```bash
sudo apt-get -y update
Expand Down Expand Up @@ -81,14 +79,14 @@ cmake -DCMAKE_BUILD_TYPE=Release ..
sudo cmake --build . --config Release --target install
```

## Create the work directory
### Create the work directory

```bash
mkdir ~/ydbwork && cd ~/ydbwork
mkdir build
```

## Install ccache
### Install ccache

Install `ccache` into `/usr/local/bin/`. The recommended version is `4.8.1` or above, the minimum required version is `4.7`.

Expand All @@ -97,13 +95,13 @@ Install `ccache` into `/usr/local/bin/`. The recommended version is `4.8.1` or a
sudo tar -xJ -C /usr/local/bin/ --strip-components=1 --no-same-owner ccache-${V}-linux-x86_64/ccache)
```

## Clone the ydb-cpp-sdk repository
### Clone the ydb-cpp-sdk repository

```bash
git clone --recurse-submodules https://github.com/ydb-platform/ydb-cpp-sdk.git
```

## Configure
### Configure

Generate build configuration using the `release` preset. `ccache` is located automatically, but if you get the warning that it's not been found, specify its location by passing `-DCCACHE_PATH=path/to/bin`

Expand All @@ -112,13 +110,13 @@ cd ydb-cpp-sdk
cmake --preset release
```

## Build
### Build

```bash
cmake --build --preset release
```

## Test
### Test

Specify a level of parallelism by passing the `-j<level>` option into the command below (e.g. `-j$(nproc)`)

Expand Down
Loading