From 0b20188fceb668f5d41f4f8c5ff40ca0f585cf9f Mon Sep 17 00:00:00 2001
From: Dmitry <b4tm4n@mail.ru>
Date: Sun, 2 Oct 2022 17:52:22 +0300
Subject: [PATCH] add README

---
 README.md | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7639a01
--- /dev/null
+++ b/README.md
@@ -0,0 +1,17 @@
+# chgk_ledb
+
+Утилита загружающая базу данных ЧГК вопросов из ZIP файла в JSON формате в базу данных.
+
+Исходный файл вопросов: `json.zip`, кодировка `UTF-8`.
+
+Выходная база: файл `./db/data.mdb`, формат базы [LMDB](https://en.wikipedia.org/wiki/Lightning_Memory-Mapped_Database).
+
+Работа с базой выполняется с помощью [ledb](https://crates.io/crates/ledb).
+
+При загрузке базы информация о пакете(файле/турнире) дублируется в каждом вопросе.
+
+## Ссылки
+
+- Источник вопросов: http://db.chgk.info
+- Копия файлов базы вопросов: https://gitlab.com/b4tman/db_chgk
+- Конвертор в JSON: https://gitea.b4tman.ru/b4tman/chgk_txt2json