Add comprehensive documentation with i18n support (EN/BG)

- Add docs/ folder with English (en/) and Bulgarian (bg/) documentation - Create index.md with language switching and links - English docs: installation, quickstart, architecture, baraql, storage, schema, lsm, btree, vector, graph, fts, columnar, transactions, distributed, protocol, udf, api-binary, api-http, api-websocket - Bulgarian docs: installation, quickstart, architecture, baraql, schema, lsm, btree, vector, graph, fts, transactions, distributed - Update README license to BSD 3-Clause - Add LICENSE file with BSD 3-Clause text
2026-05-06 16:51:14 +03:00
parent f9f77b3a18
commit e1bae0c7a0
34 changed files with 2370 additions and 1 deletions
@@ -0,0 +1,96 @@
+# BaraDB - Ръководство за Инсталация
+
+## Изисквания
+
+- **Nim Компилатор** >= 2.0.0
+- **Операционна система**: Linux, macOS, Windows
+
+## Инсталиране на Nim
+
+### Linux/macOS
+
+```bash
+curl https://nim-lang.org/choosenim/init.sh -sSf | sh
+```
+
+Или чрез пакетен мениджър:
+
+```bash
+# Ubuntu/Debian
+apt-get install nim
+
+# macOS
+brew install nim
+```
+
+### Windows
+
+Изтеглете инсталатора от [nim-lang.org](https://nim-lang.org/install.html) или използвайте winget:
+
+```powershell
+winget install nim
+```
+
+## Компилиране на BaraDB
+
+### Клониране на Репозиторито
+
+```bash
+git clone https://github.com/katehonz/barabaDB.git
+cd barabaDB
+```
+
+### Компилиране
+
+```bash
+# Debug компилация
+nim c -o:build/baradadb src/baradadb.nim
+
+# Release компилация (оптимизирана)
+nim c -d:release -o:build/baradadb src/baradadb.nim
+```
+
+### Стартиране на Тестове
+
+```bash
+nim c --path:src -r tests/test_all.nim
+```
+
+### Стартиране на Бенчмаркове
+
+```bash
+nim c -d:release -r benchmarks/bench_all.nim
+```
+
+## Опции за Инсталация
+
+### Docker
+
+```bash
+docker pull barabadb/barabadb
+docker run -it barabadb/barabadb
+```
+
+### Вградено Използване
+
+Добавете към вашия `.nimble` файл:
+
+```nim
+requires "barabadb >= 1.0.0"
+```
+
+След това импортнете в кода:
+
+```nim
+import barabadb
+
+var db = newLSMTree("./data")
+db.put("key1", cast[seq[byte]]("value1"))
+db.close()
+```
+
+## Следващи Стъпки
+
+- [Бързо Стартиране](bg/quickstart.md)
+- [Архитектура](bg/architecture.md)
+- [BaraQL Заявки](bg/baraql.md)