Skip to content

Commit 063b292

Browse files
authored
Update header for README.md
1 parent b323984 commit 063b292

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
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 alpha version of C++ driver for [YDB](https://github.com/ydb-platform/ydb), don't use it in production environment!
33

44
If you ok with this warning, then...
55

6-
# Building YDB C++ SDK from sources
6+
## Building YDB C++ SDK from sources
77

8-
## Prerequisites
8+
### Prerequisites
99

1010
- cmake 3.22+
1111
- clang 16+
@@ -15,7 +15,7 @@ If you ok with this warning, then...
1515
- yasm
1616
- protoc
1717

18-
## Library dependencies
18+
### Library dependencies
1919

2020
- gRPC
2121
- protobuf
@@ -33,17 +33,17 @@ If you ok with this warning, then...
3333
- double-conversion
3434
- jwt-cpp
3535

36-
## Runtime requirements
36+
### Runtime requirements
3737

3838
- libidn11-dev (IDN)
3939
- libiconv (Iconv)
4040

41-
## Testing requirements
41+
### Testing requirements
4242

4343
- gtest
4444
- gmock
4545

46-
## Install dependencies
46+
### Install dependencies
4747

4848
```bash
4949
sudo apt-get -y update
@@ -81,14 +81,14 @@ cmake -DCMAKE_BUILD_TYPE=Release ..
8181
sudo cmake --build . --config Release --target install
8282
```
8383

84-
## Create the work directory
84+
### Create the work directory
8585

8686
```bash
8787
mkdir ~/ydbwork && cd ~/ydbwork
8888
mkdir build
8989
```
9090

91-
## Install ccache
91+
### Install ccache
9292

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

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

100-
## Clone the ydb-cpp-sdk repository
100+
### Clone the ydb-cpp-sdk repository
101101

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

106-
## Configure
106+
### Configure
107107

108108
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`
109109

@@ -112,13 +112,13 @@ cd ydb-cpp-sdk
112112
cmake --preset release
113113
```
114114

115-
## Build
115+
### Build
116116

117117
```bash
118118
cmake --build --preset release
119119
```
120120

121-
## Test
121+
### Test
122122

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

0 commit comments

Comments
 (0)