aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5469c89
--- /dev/null
+++ b/README.md
@@ -0,0 +1,13 @@
+# Складской учет (warehouse accounting)
+
+## Запуск
+
+Перейдите в директорию deployments и запустите `docker compose up`.
+
+Накатите up миграции из `src/main/sql`. Проще всего это сделать через psql / pgadmin / средства IDE.
+
+Далее запускайте приложение.
+
+## Документация
+
+Расположена в [папке docs](./docs/README.md). \ No newline at end of file