Add installtaion guide (#6)

Previously, the README lacked clear installation instructions, which could confuse new users.

This MR adds a dedicated installation section with step-by-step guidance.

Author: hackallcode

README.md

@@ -1,13 +1,16 @@
 # Synthetic Data Values Generator (SDVG)
 
 [![Release][release-badge]][release-url]
+[![Pre-release][pre-release-badge]][pre-release-url]
 [![CI][actions-badge]][actions-url]
 [![Coverage Status][test-coverage-badge]][test-coverage-url]
 [![Language][language-badge]][language-url]
 [![License][license-badge]][license-url]
 
-[release-badge]: https://img.shields.io/github/v/release/tarantool/sdvg?filter=!latest
-[release-url]: https://github.com/tarantool/sdvg/releases
+[release-badge]: https://img.shields.io/github/v/release/tarantool/sdvg
+[release-url]: https://github.com/tarantool/sdvg/releases/latest/
+[pre-release-badge]: https://img.shields.io/badge/pre--release-latest-orange
+[pre-release-url]: https://github.com/tarantool/sdvg/releases/tag/latest/
 [actions-badge]: https://img.shields.io/github/check-runs/tarantool/sdvg/master
 [actions-url]: https://github.com/tarantool/sdvg/actions
 [test-coverage-badge]: https://img.shields.io/coverallsCoverage/github/tarantool/sdvg?branch=master
@@ -17,6 +20,8 @@
 [license-badge]: https://img.shields.io/github/license/tarantool/sdvg
 [license-url]: ./LICENSE
 
+![scheme.png](asset/scheme.png)
+
 ## Language
 
 - **English**
@@ -64,6 +69,66 @@ Output formats:
 - HTTP API;
 - Tarantool Column Store HTTP API.
 
+## Installation
+
+### Standard installation
+
+You can install SDVG by downloading the appropriate binary version
+from the [GitHub Releases page](https://github.com/tarantool/sdvg/releases).
+
+Download binary for your OS:
+
+```shell
+# Linux (x86-64)
+curl -Lo sdvg https://github.com/tarantool/sdvg/releases/latest/download/sdvg-linux-amd64
+```
+
+```shell
+# Linux (ARM64)
+curl -Lo sdvg https://github.com/tarantool/sdvg/releases/latest/download/sdvg-linux-arm64
+```
+
+```shell
+# macOS (x86-64)
+curl -Lo sdvg https://github.com/tarantool/sdvg/releases/latest/download/sdvg-darwin-amd64
+```
+
+```shell
+# macOS (ARM64)
+curl -Lo sdvg https://github.com/tarantool/sdvg/releases/latest/download/sdvg-darwin-arm64
+```
+
+Install binary in your system:
+
+```shell
+chmod +x sdvg
+sudo mv sdvg /usr/local/bin/sdvg
+```
+
+Check that everything works correctly:
+
+```shell
+sdvg version
+```
+
+### Compile and install from sources
+
+To compile and install this tool, you can use `go install` command:
+
+```shell
+# To get the specified version
+go install github.com/tarantool/sdvg@0.0.2
+# To get a version from the master branch
+go clean -modcache
+go install github.com/tarantool/sdvg@latest
+```
+
+Check that everything works correctly:
+
+```shell
+sdvg version
+```
+
 ## Quick Start
 
 Here's an example of a data model that generates 10,000 user rows and writes them to a CSV file:
@@ -86,7 +151,7 @@ models:
 Save this as `simple_model.yml`, then run:
 
 ```bash
-./sdvg generate simple_model.yml
+sdvg generate simple_model.yml
 ```
 
 This will create a CSV file with fake user data like `id` and `name`:
@@ -102,15 +167,15 @@ b5c024f8-3f6f-43d3-b021-0bb2305cc680,Hilton
 To launch the generator in interactive mode:
 
 ```bash
-./sdvg
+sdvg
 ```
 
 To view available commands and arguments:
 
 ```bash
-./sdvg -h
-./sdvg --help
-./sdvg generate -h
+sdvg -h
+sdvg --help
+sdvg generate -h
 ```
 
 More information can be found in the [user guide](./doc/en/usage.md).

README.ru.md

@@ -1,13 +1,16 @@
 # Synthetic Data Values Generator (SDVG)
 
 [![Release][release-badge]][release-url]
+[![Pre-release][pre-release-badge]][pre-release-url]
 [![CI][actions-badge]][actions-url]
 [![Coverage Status][test-coverage-badge]][test-coverage-url]
 [![Language][language-badge]][language-url]
 [![License][license-badge]][license-url]
 
-[release-badge]: https://img.shields.io/github/v/release/tarantool/sdvg?filter=!latest
-[release-url]: https://github.com/tarantool/sdvg/releases
+[release-badge]: https://img.shields.io/github/v/release/tarantool/sdvg
+[release-url]: https://github.com/tarantool/sdvg/releases/latest/
+[pre-release-badge]: https://img.shields.io/badge/pre--release-latest-orange
+[pre-release-url]: https://github.com/tarantool/sdvg/releases/tag/latest/
 [actions-badge]: https://img.shields.io/github/check-runs/tarantool/sdvg/master
 [actions-url]: https://github.com/tarantool/sdvg/actions
 [test-coverage-badge]: https://img.shields.io/coverallsCoverage/github/tarantool/sdvg?branch=master
@@ -17,6 +20,8 @@
 [license-badge]: https://img.shields.io/github/license/tarantool/sdvg
 [license-url]: ./LICENSE
 
+![scheme.png](asset/scheme.png)
+
 ## Язык
 
 - [English](README.md)
@@ -64,6 +69,66 @@ SDVG (Synthetic Data Values Generator) — это инструмент для г
 - HTTP API;
 - Tarantool Column Store HTTP API.
 
+## Установка
+
+### Стандартная установка
+
+Вы можете установить SDVG, скачав готовый бинарный файл нужной версии
+со [страницы релизов на GitHub](https://github.com/tarantool/sdvg/releases).
+
+Скачайте бинарный файл для вашей операционной системы:
+
+```shell
+# Linux (x86-64)
+curl -Lo sdvg https://github.com/tarantool/sdvg/releases/latest/download/sdvg-linux-amd64
+```
+
+```shell
+# Linux (ARM64)
+curl -Lo sdvg https://github.com/tarantool/sdvg/releases/latest/download/sdvg-linux-arm64
+```
+
+```shell
+# macOS (x86-64)
+curl -Lo sdvg https://github.com/tarantool/sdvg/releases/latest/download/sdvg-darwin-amd64
+```
+
+```shell
+# macOS (ARM64)
+curl -Lo sdvg https://github.com/tarantool/sdvg/releases/latest/download/sdvg-darwin-arm64
+```
+
+Установите бинарный файл в систему:
+
+```shell
+chmod +x sdvg
+sudo mv sdvg /usr/local/bin/sdvg
+```
+
+Проверьте, что все работает правильно:
+
+```shell
+sdvg version
+```
+
+### Сборка и установка из исходников
+
+Для сборки и установки этого инструмента можно использовать команду `go install`:
+
+```shell
+# Чтобы установить указанную версию
+go install github.com/tarantool/sdvg@0.0.2
+# Чтобы установить версию из ветки master
+go clean -modcache
+go install github.com/tarantool/sdvg@latest
+```
+
+Проверьте, что все работает правильно:
+
+```shell
+sdvg version
+```
+
 ## Быстрый старт
 
 Пример модели данных, которая генерирует 10 000 строк пользователей и записывает их в CSV-файл:
@@ -86,7 +151,7 @@ models:
 Сохраните это в файл `simple_model.yml`, затем выполните:
 
 ```bash
-./sdvg generate simple_model.yml
+sdvg generate simple_model.yml
 ```
 
 Это создаст CSV-файл с фейковыми пользовательскими данными, такими как `id` и `name`:
@@ -102,15 +167,15 @@ b5c024f8-3f6f-43d3-b021-0bb2305cc680,Hilton
 Чтобы запустить генератор в интерактивном режиме:
 
 ```bash
-./sdvg
+sdvg
 ```
 
 Чтобы посмотреть доступные команды и аргументы:
 
 ```bash
-./sdvg -h
-./sdvg --help
-./sdvg generate -h
+sdvg -h
+sdvg --help
+sdvg generate -h
 ```
 
 Больше информации можно найти в [руководстве по эксплуатации](./doc/ru/usage.md).

asset/scheme.png

@@ -12,4 +12,4 @@
 #open_ai:
 #  api_key:
 #  base_url:
-#  model:
+#  model:

config/config.yml

@@ -30,5 +30,5 @@ To release a new version:
 
 1. Review and update the changelog in [CHANGELOG.md](../../CHANGELOG.md) if needed.
 2. Add a new header for the release version with a link to the git diff in [CHANGELOG.md](../../CHANGELOG.md).
-   Use the format: `## [0.0.0](https://.../compare/prev...current) - 2000-12-31`;
+   Use the format: `## [0.0.0](https://.../compare/prev...current) - 2000-12-31`.
 3. Commit to the main branch (via MR) with a commit message containing `release 0.0.0`.

doc/en/contributing.md

@@ -425,15 +425,15 @@ models:
 Для запуска в интерактивном режиме достаточно запустить бинарный файл SDVG:
 
 ```shell
-./sdvg
+sdvg
 ```
 
 Для получения информации о возможных командах и их аргументах:
 
 ```shell
-./sdvg -h
-./sdvg --help
-./sdvg generate -h
+sdvg -h
+sdvg --help
+sdvg generate -h
 ```
 
 ### Генерация данных
@@ -445,7 +445,7 @@ models:
 Для запуска генерации с указанием файла конфигурации генерации:
 
 ```shell
-./sdvg generate ./models.yml
+sdvg generate ./models.yml
 ```
 
 ### Игнорирование конфликтов
@@ -454,15 +454,15 @@ models:
 и продолжить генерацию без дополнительных сообщений, используйте флаг `-F` или `--force`:
 
 ```shell
-./sdvg generate --force ./models.yml
+sdvg generate --force ./models.yml
 ```
 
 ### Продолжение генерации
 
 Для продолжения генерации с последней записанной строки:
 
 ```shell
-./sdvg generate --continue-generation ./models.yml
+sdvg generate --continue-generation ./models.yml
 ```
 
 > **Важно**: для корректного продолжения генерации нельзя менять конфигурацию генерации и уже сгенерированные данные.