Skip to content

Commit e3b9151

Browse files
authored
Merge pull request #327 from ydb-platform/fix-readme-header
Update header for README.md
2 parents b323984 + 624615b commit e3b9151

File tree

1 file changed

+14
-16
lines changed

1 file changed

+14
-16
lines changed

README.md

Lines changed: 14 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,9 @@
1-
# WARNING: THIS IS SUPER MEGA EXTRA ALPHA VERSION OF C++ DRIVER FOR YDB!!!
2-
# Don't use it in production environment!
1+
# YDB C++ SDK
2+
## This is a pre-release version of the C++ driver for [YDB](https://github.com/ydb-platform/ydb), backward compatibility is not guaranteed!
33

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

6-
# Building YDB C++ SDK from sources
7-
8-
## Prerequisites
6+
### Prerequisites
97

108
- cmake 3.22+
119
- clang 16+
@@ -15,7 +13,7 @@ If you ok with this warning, then...
1513
- yasm
1614
- protoc
1715

18-
## Library dependencies
16+
### Library dependencies
1917

2018
- gRPC
2119
- protobuf
@@ -33,17 +31,17 @@ If you ok with this warning, then...
3331
- double-conversion
3432
- jwt-cpp
3533

36-
## Runtime requirements
34+
### Runtime requirements
3735

3836
- libidn11-dev (IDN)
3937
- libiconv (Iconv)
4038

41-
## Testing requirements
39+
### Testing requirements
4240

4341
- gtest
4442
- gmock
4543

46-
## Install dependencies
44+
### Install dependencies
4745

4846
```bash
4947
sudo apt-get -y update
@@ -81,14 +79,14 @@ cmake -DCMAKE_BUILD_TYPE=Release ..
8179
sudo cmake --build . --config Release --target install
8280
```
8381

84-
## Create the work directory
82+
### Create the work directory
8583

8684
```bash
8785
mkdir ~/ydbwork && cd ~/ydbwork
8886
mkdir build
8987
```
9088

91-
## Install ccache
89+
### Install ccache
9290

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

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

100-
## Clone the ydb-cpp-sdk repository
98+
### Clone the ydb-cpp-sdk repository
10199

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

106-
## Configure
104+
### Configure
107105

108106
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`
109107

@@ -112,13 +110,13 @@ cd ydb-cpp-sdk
112110
cmake --preset release
113111
```
114112

115-
## Build
113+
### Build
116114

117115
```bash
118116
cmake --build --preset release
119117
```
120118

121-
## Test
119+
### Test
122120

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

0 commit comments

Comments
 (0)