summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorescfrpls <licwin1410@gmail.com>2026-07-24 19:20:42 +0200
committerescfrpls <licwin1410@gmail.com>2026-07-24 19:20:42 +0200
commitc063160a48e68ccb1f4a0b31ffceba0b69f0e9fd (patch)
tree22cde1bcc5e457ce543d661e6797194e26063343
parentf232c1119e73bf6d09536fd2368e3b0141129699 (diff)
add READMYHEADmaster
-rw-r--r--README.md81
1 files changed, 71 insertions, 10 deletions
diff --git a/README.md b/README.md
index 11bbe12..3f6a731 100644
--- a/README.md
+++ b/README.md
@@ -1,18 +1,79 @@
-# Documentation
+# πŸ›οΈ AI Genealogy / ИИ ГСнСалогия
-### Russia
-**Π—Π΄Π΅ΡΡŒ хранятся ΠΌΠΎΠΈ Π»ΠΈΡ‡Π½Ρ‹Π΅ Π·Π°ΠΌΠ΅Ρ‚ΠΊΠΈ, инструкции, Π³Π°ΠΉΠ΄Ρ‹ ΠΈ Π΄Ρ€ΡƒΠ³ΠΈΠ΅ Π²ΡΠΏΠΎΠΌΠΎΠ³Π°Ρ‚Π΅Π»ΡŒΠ½Ρ‹Π΅ ΠΌΠ°Ρ‚Π΅Ρ€ΠΈΠ°Π»Ρ‹ - просто Ρ‡Ρ‚ΠΎΠ±Ρ‹ Π½Π΅ Π·Π°Π±Ρ‹Ρ‚ΡŒ ΠΈ всСгда ΠΈΠΌΠ΅Ρ‚ΡŒ ΠΏΠΎΠ΄ Ρ€ΡƒΠΊΠΎΠΉ.**
+**Local AI assistant for genealogical research**
+**Π›ΠΎΠΊΠ°Π»ΡŒΠ½Ρ‹ΠΉ ИИ-ΠΏΠΎΠΌΠΎΡ‰Π½ΠΈΠΊ для гСнСалогичСских исслСдований**
-Π Π΅ΠΏΠΎΠ·ΠΈΡ‚ΠΎΡ€ΠΈΠΉ Π½Π΅ привязан ΠΊ ΠΎΡ‚Π΄Π΅Π»ΡŒΠ½ΠΎΠΌΡƒ сайту, это коллСкция ΠΏΠΎΠ»Π΅Π·Π½Ρ‹Ρ… записСй.
+---
-* πŸ“‚ Π Π΅ΠΏΠΎΠ·ΠΈΡ‚ΠΎΡ€ΠΈΠΉ: [https://git.drohiczyn-poleski.com/documentation.git](https://git.drohiczyn-poleski.com/documentation.git)
+## πŸ‡¬πŸ‡§ What is this?
----
+A fully local, open-source AI toolkit for genealogical research. It runs entirely on your computer β€” no cloud services, no subscriptions, no data leaks.
+
+### Capabilities
+- πŸ” **Semantic search** through your archive of digitized documents
+- πŸ“œ **OCR recognition** of old metric books, scans, and manuscripts (Russian, Polish, Belarusian)
+- 🌐 **Private web search** via SearXNG meta-search engine
+- πŸ•ΈοΈ **Website scraping** of genealogy forums and archives
+- πŸ’¬ **AI chat** with context from your documents (RAG)
+- 🧠 **Analysis** of surnames, dates, places, family connections
+
+### Tech Stack
+| Component | Purpose |
+|-----------|---------|
+| Open WebUI | Web interface |
+| Ollama + Qwen2.5/Mistral | LLM |
+| Qdrant + BGE-M3 | Vector search |
+| EasyOCR + Tesseract | OCR |
+| SearXNG | Web search |
+| Crawl4AI | Web scraping |
+| FastAPI | Integration API |
+
+### Quick Start
+```bash
+ai-genealogy start # Launch
+ai-genealogy stop # Shutdown (GPU freed)
+
+Web UI: http://localhost:3000
+API Docs: http://localhost:8000/docs
+
+----------------------------------------------------------------------------------------------
+
+ΠŸΠΎΠ»Π½ΠΎΡΡ‚ΡŒΡŽ Π»ΠΎΠΊΠ°Π»ΡŒΠ½Ρ‹ΠΉ, ΠΎΡ‚ΠΊΡ€Ρ‹Ρ‚Ρ‹ΠΉ AI-инструмСнтарий для гСнСалогичСских исслСдований. Всё Ρ€Π°Π±ΠΎΡ‚Π°Π΅Ρ‚ Π½Π° вашСм ΠΊΠΎΠΌΠΏΡŒΡŽΡ‚Π΅Ρ€Π΅ β€” Π±Π΅Π· ΠΎΠ±Π»Π°ΠΊΠΎΠ², подписок ΠΈ ΡƒΡ‚Π΅Ρ‡Π΅ΠΊ Π΄Π°Π½Π½Ρ‹Ρ….
+ВозмоТности
+
+ πŸ” БСмантичСский поиск ΠΏΠΎ Π²Π°ΡˆΠ΅ΠΌΡƒ Π°Ρ€Ρ…ΠΈΠ²Ρƒ ΠΎΡ†ΠΈΡ„Ρ€ΠΎΠ²Π°Π½Π½Ρ‹Ρ… Π΄ΠΎΠΊΡƒΠΌΠ΅Π½Ρ‚ΠΎΠ²
+
+ πŸ“œ РаспознаваниС (OCR) старых мСтричСских ΠΊΠ½ΠΈΠ³, сканов, рукописСй (русский, польский, бСлорусский)
+
+ 🌐 ΠŸΡ€ΠΈΠ²Π°Ρ‚Π½Ρ‹ΠΉ Π²Π΅Π±-поиск Ρ‡Π΅Ρ€Π΅Π· ΠΌΠ΅Ρ‚Π°-поисковик SearXNG
+
+ πŸ•ΈοΈ Π‘ΠΊΡ€Π°ΠΏΠΈΠ½Π³ сайтов β€” гСнСалогичСских Ρ„ΠΎΡ€ΡƒΠΌΠΎΠ² ΠΈ Π°Ρ€Ρ…ΠΈΠ²ΠΎΠ²
+
+ πŸ’¬ AI-Ρ‡Π°Ρ‚ с контСкстом ΠΈΠ· Π²Π°ΡˆΠΈΡ… Π΄ΠΎΠΊΡƒΠΌΠ΅Π½Ρ‚ΠΎΠ² (RAG)
+
+ 🧠 Анализ Ρ„Π°ΠΌΠΈΠ»ΠΈΠΉ, Π΄Π°Ρ‚, мСст, родствСнных связСй
+
+ВСхнологичСский стСк
+ΠšΠΎΠΌΠΏΠΎΠ½Π΅Π½Ρ‚ НазначСниС
+Open WebUI Π’Π΅Π±-интСрфСйс
+Ollama + Qwen2.5/Mistral Языковая модСль (LLM)
+Qdrant + BGE-M3 Π’Π΅ΠΊΡ‚ΠΎΡ€Π½Ρ‹ΠΉ поиск
+EasyOCR + Tesseract РаспознаваниС тСкста
+SearXNG Π’Π΅Π±-поиск
+Crawl4AI Π‘ΠΊΡ€Π°ΠΏΠΈΠ½Π³ сайтов
+FastAPI API-интСграция
+Быстрый старт
+bash
+
+ai-genealogy start # Запуск
+ai-genealogy stop # Π’Ρ‹ΠΊΠ»ΡŽΡ‡Π΅Π½ΠΈΠ΅ (GPU освобоТдаСтся)
-### English
+Π’Π΅Π±-интСрфСйс: http://localhost:3000
+API докумСнтация: http://localhost:8000/docs
-**This is where I keep my personal notes, how‑to guides, instructions and other reference materials - so I don’t forget them and always have them at hand.**
+----------------------------------------------------------------------------------------------
-The repository is not linked to a dedicated website; it is just a collection of useful writings.
+πŸ”“ License / ЛицСнзия
-* πŸ“‚ Repository: [https://git.drohiczyn-poleski.com/documentation.git](https://git.drohiczyn-poleski.com/documentation.git)
+All components are open-source (MIT, Apache 2.0, AGPLv3).
+ВсС ΠΊΠΎΠΌΠΏΠΎΠ½Π΅Π½Ρ‚Ρ‹ с ΠΎΡ‚ΠΊΡ€Ρ‹Ρ‚Ρ‹ΠΌ исходным ΠΊΠΎΠ΄ΠΎΠΌ (MIT, Apache 2.0, AGPLv3).