Skip to content

Commit a1b394c

Browse files
committed
Add installtaion guide
Previously, the README lacked clear installation instructions, which could confuse new users. This MR adds a dedicated installation section with step-by-step guidance for Linux and macOS.
1 parent d94be74 commit a1b394c

File tree

5 files changed

+86
-6
lines changed

5 files changed

+86
-6
lines changed

README.md

Lines changed: 42 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,16 @@
11
# Synthetic Data Values Generator (SDVG)
22

33
[![Release][release-badge]][release-url]
4+
[![Pre-release][pre-release-badge]][pre-release-url]
45
[![CI][actions-badge]][actions-url]
56
[![Coverage Status][test-coverage-badge]][test-coverage-url]
67
[![Language][language-badge]][language-url]
78
[![License][license-badge]][license-url]
89

9-
[release-badge]: https://img.shields.io/github/v/release/tarantool/sdvg?filter=!latest
10-
[release-url]: https://github.com/tarantool/sdvg/releases
10+
[release-badge]: https://img.shields.io/github/v/release/tarantool/sdvg
11+
[release-url]: https://github.com/tarantool/sdvg/releases/latest/
12+
[pre-release-badge]: https://img.shields.io/badge/pre--release-latest-orange
13+
[pre-release-url]: https://github.com/tarantool/sdvg/releases/tag/latest/
1114
[actions-badge]: https://img.shields.io/github/check-runs/tarantool/sdvg/master
1215
[actions-url]: https://github.com/tarantool/sdvg/actions
1316
[test-coverage-badge]: https://img.shields.io/coverallsCoverage/github/tarantool/sdvg?branch=master
@@ -17,6 +20,8 @@
1720
[license-badge]: https://img.shields.io/github/license/tarantool/sdvg
1821
[license-url]: ./LICENSE
1922

23+
![scheme.png](asset/scheme.png)
24+
2025
## Language
2126

2227
- **English**
@@ -64,6 +69,41 @@ Output formats:
6469
- HTTP API;
6570
- Tarantool Column Store HTTP API.
6671

72+
## Installation
73+
74+
You can install SDVG by downloading the appropriate binary version
75+
from the [GitHub Releases page](https://github.com/tarantool/sdvg/releases).
76+
77+
Download binary for your OS:
78+
79+
```shell
80+
# Linux (x86-64)
81+
curl -Lo sdvg https://github.com/tarantool/sdvg/releases/latest/download/sdvg-linux-amd64
82+
```
83+
84+
```shell
85+
# Linux (ARM64)
86+
curl -Lo sdvg https://github.com/tarantool/sdvg/releases/latest/download/sdvg-linux-arm64
87+
```
88+
89+
```shell
90+
# macOS (x86-64)
91+
curl -Lo sdvg https://github.com/tarantool/sdvg/releases/latest/download/sdvg-darwin-amd64
92+
```
93+
94+
```shell
95+
# macOS (ARM64)
96+
curl -Lo sdvg https://github.com/tarantool/sdvg/releases/latest/download/sdvg-darwin-arm64
97+
```
98+
99+
Install binary in your system:
100+
101+
```shell
102+
chmod +x sdvg
103+
sudo mv sdvg /usr/local/bin/sdvg
104+
sdvg version
105+
```
106+
67107
## Quick Start
68108

69109
Here's an example of a data model that generates 10,000 user rows and writes them to a CSV file:

README.ru.md

Lines changed: 42 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,16 @@
11
# Synthetic Data Values Generator (SDVG)
22

33
[![Release][release-badge]][release-url]
4+
[![Pre-release][pre-release-badge]][pre-release-url]
45
[![CI][actions-badge]][actions-url]
56
[![Coverage Status][test-coverage-badge]][test-coverage-url]
67
[![Language][language-badge]][language-url]
78
[![License][license-badge]][license-url]
89

9-
[release-badge]: https://img.shields.io/github/v/release/tarantool/sdvg?filter=!latest
10-
[release-url]: https://github.com/tarantool/sdvg/releases
10+
[release-badge]: https://img.shields.io/github/v/release/tarantool/sdvg
11+
[release-url]: https://github.com/tarantool/sdvg/releases/latest/
12+
[pre-release-badge]: https://img.shields.io/badge/pre--release-latest-orange
13+
[pre-release-url]: https://github.com/tarantool/sdvg/releases/tag/latest/
1114
[actions-badge]: https://img.shields.io/github/check-runs/tarantool/sdvg/master
1215
[actions-url]: https://github.com/tarantool/sdvg/actions
1316
[test-coverage-badge]: https://img.shields.io/coverallsCoverage/github/tarantool/sdvg?branch=master
@@ -17,6 +20,8 @@
1720
[license-badge]: https://img.shields.io/github/license/tarantool/sdvg
1821
[license-url]: ./LICENSE
1922

23+
![scheme.png](asset/scheme.png)
24+
2025
## Язык
2126

2227
- [English](README.md)
@@ -64,6 +69,41 @@ SDVG (Synthetic Data Values Generator) — это инструмент для г
6469
- HTTP API;
6570
- Tarantool Column Store HTTP API.
6671

72+
## Установка
73+
74+
Вы можете установить SDVG, скачав готовый бинарный файл нужной версии
75+
со [страницы релизов на GitHub](https://github.com/tarantool/sdvg/releases).
76+
77+
Скачайте бинарный файл для вашей операционной системы:
78+
79+
```shell
80+
# Linux (x86-64)
81+
curl -Lo sdvg https://github.com/tarantool/sdvg/releases/latest/download/sdvg-linux-amd64
82+
```
83+
84+
```shell
85+
# Linux (ARM64)
86+
curl -Lo sdvg https://github.com/tarantool/sdvg/releases/latest/download/sdvg-linux-arm64
87+
```
88+
89+
```shell
90+
# macOS (x86-64)
91+
curl -Lo sdvg https://github.com/tarantool/sdvg/releases/latest/download/sdvg-darwin-amd64
92+
```
93+
94+
```shell
95+
# macOS (ARM64)
96+
curl -Lo sdvg https://github.com/tarantool/sdvg/releases/latest/download/sdvg-darwin-arm64
97+
```
98+
99+
Установите бинарный файл в систему:
100+
101+
```shell
102+
chmod +x sdvg
103+
sudo mv sdvg /usr/local/bin/sdvg
104+
sdvg version
105+
```
106+
67107
## Быстрый старт
68108

69109
Пример модели данных, которая генерирует 10 000 строк пользователей и записывает их в CSV-файл:

asset/scheme.png

386 KB
Loading

config/config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,4 @@
1212
#open_ai:
1313
# api_key:
1414
# base_url:
15-
# model:
15+
# model:

doc/en/contributing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,5 +30,5 @@ To release a new version:
3030

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

0 commit comments

Comments
 (0)