Readme : Add basic info and known problems.
This commit is contained in:
parent
dbc040e41b
commit
4c6228e2f1
30
Readme.md
Normal file
30
Readme.md
Normal file
|
@ -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. Заранее не знаю Ваш предпочтительный уровень профессионализма.
|
Reference in a new issue