From 063b29204bd8bfb4c9036ab7947aedd028934ea1 Mon Sep 17 00:00:00 2001 From: Bulat Date: Wed, 9 Oct 2024 18:03:29 +0300 Subject: [PATCH 1/5] Update header for README.md --- README.md | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 9475dcfb66..7ac2c72003 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ -# 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 alpha version of C++ driver for [YDB](https://github.com/ydb-platform/ydb), don't use it in production environment! 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+ @@ -15,7 +15,7 @@ If you ok with this warning, then... - yasm - protoc -## Library dependencies +### Library dependencies - gRPC - protobuf @@ -33,17 +33,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 @@ -81,14 +81,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`. @@ -97,13 +97,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` @@ -112,13 +112,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` option into the command below (e.g. `-j$(nproc)`) From ecf31ac273d83fb7e3d78318a889f565797a9266 Mon Sep 17 00:00:00 2001 From: Bulat Gayazov Date: Wed, 9 Oct 2024 15:06:31 +0000 Subject: [PATCH 2/5] Fixed header --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 7ac2c72003..b2f16b2071 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # YDB C++ SDK -## This is alpha version of C++ driver for [YDB](https://github.com/ydb-platform/ydb), don't use it in production environment! +## This is alpha version of C++ driver for [YDB](https://github.com/ydb-platform/ydb), backward compatibility is not guaranteed! If you ok with this warning, then... From 9dcc6806a47d630189db3a22eff77c57b0297d79 Mon Sep 17 00:00:00 2001 From: Bulat Gayazov Date: Wed, 9 Oct 2024 15:23:47 +0000 Subject: [PATCH 3/5] Fixed issues --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index b2f16b2071..20dcd7d1e9 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,6 @@ # YDB C++ SDK ## This is alpha version of 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 ### Prerequisites From 331e1a3200642d90ab9fadb0af01e61e8b5bb7ae Mon Sep 17 00:00:00 2001 From: Bulat Gayazov Date: Thu, 10 Oct 2024 11:38:48 +0000 Subject: [PATCH 4/5] Changed alpha to pre-release --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 20dcd7d1e9..b1fecc275a 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # YDB C++ SDK -## This is alpha version of C++ driver for [YDB](https://github.com/ydb-platform/ydb), backward compatibility is not guaranteed! +## This is pre-release version of C++ driver for [YDB](https://github.com/ydb-platform/ydb), backward compatibility is not guaranteed! ## Building YDB C++ SDK from sources From 624615b8cff1f6004b5f3ddcacd2ba12e2cf77aa Mon Sep 17 00:00:00 2001 From: Bulat Gayazov Date: Thu, 10 Oct 2024 11:55:51 +0000 Subject: [PATCH 5/5] Fixed articles --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b1fecc275a..315188e166 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # YDB C++ SDK -## This is pre-release version of C++ driver for [YDB](https://github.com/ydb-platform/ydb), backward compatibility is not guaranteed! +## This is a pre-release version of the C++ driver for [YDB](https://github.com/ydb-platform/ydb), backward compatibility is not guaranteed! ## Building YDB C++ SDK from sources