From 4c6228e2f18b793036af916f87beb5b6b9caedce Mon Sep 17 00:00:00 2001
From: Dmitry Voronin <hi@voronind.com>
Date: Mon, 23 Sep 2024 15:05:08 +0300
Subject: [PATCH] Readme : Add basic info and known problems.

---
 Readme.md | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)
 create mode 100644 Readme.md

diff --git a/Readme.md b/Readme.md
new file mode 100644
index 0000000..7073a8a
--- /dev/null
+++ b/Readme.md
@@ -0,0 +1,30 @@
+# 2gis тестовое задание (Title crawler).
+
+# Запуск.
+
+## (Optional) Среда сборки используя лучший под солнцем пакетник Nix.
+
+```bash
+nix develop
+```
+
+P.S. Docker тоже хорошо умею если нужно.
+
+## Run make.
+
+```bash
+make
+```
+
+# Известные проблемы.
+
+0. Малый опыт работы со Scala, hence не знаю многих best practice. Решается просто - кто-то очень опытный проводит код ревью какое-то время.
+1. `sbt` отказывается сам воспринимать JAVA_HOME. Не знаю, надо так или нет (тот же Gradle сам цепляет), но я "зашил" костыликом в Makefile.
+
+# Источники вдохновения.
+
+[Simple Http Server](https://github.com/softwaremill/simple-http-server/blob/master/src/main/scala/com/softwaremill/httpserver/SimpleHttpServer.scala)
+
+# Прочее.
+
+Воздержался от emoji в Readme. Заранее не знаю Ваш предпочтительный уровень профессионализма.