57 pages with user documentation

.gitignore

@@ -12,3 +12,4 @@ docs/.$DB_Diagram.drawio.bkp
 build/*
 dist/*
 app.spec
+*.drawio.bkp

README.md

@@ -1,16 +1,12 @@
-# GUI для работы с байесовским выводом (байесовские сети)
+![GitHub Release](https://img.shields.io/github/v/release/Digiratory/bayes_model?link=https%3A%2F%2Fgithub.com%2FDigiratory%2Fbayes_model%2Freleases)
+![GitHub Issues or Pull Requests](https://img.shields.io/github/issues/Digiratory/bayes_model?link=https%3A%2F%2Fgithub.com%2FDigiratory%2Fbayes_model%2Fissues)
+![GitHub Downloads (all assets, all releases)](https://img.shields.io/github/downloads/Digiratory/bayes_model/total?label=GitHub%20Downloads)
+![PyPI - Downloads](https://img.shields.io/pypi/dm/bn_modeller?label=PyPI%20-%20Downloads&link=https%3A%2F%2Fpypi.org%2Fproject%2Fbn-modeller%2F)
 
-на основе библиотеки py_banshee
-
-
-- Разрабатывалась для задачи поиска когнитивной состовляющий при назначении слуховых аппаратов, но хочется, чтобы можно было использовать для любых данных
-
-Если не работает именно py_banshee, попробуй залесть в код библиотеки py_banshee и исправить:
-/home/work/.local/lib/python3.8/site-packages/py_banshee
-
-predict 307
-
-func_i = interp1d(fe, xe, kind=way, fill_value="extrapolate")  # interpolation fill_value="extrapolate"
+<p align="center">
+    <h1 align="center">BN Modeller</h1>
+    <p align="center">An open-source application designed to facilitate feature dependency modeling and evaluation using Bayesian Networks.</p>
+</p>
 
 ## Instalation
 
@@ -20,24 +16,13 @@ You can install this project using pip:
 pip install bn_modeller
 ```
 
-## Build
-
-### Build Executable file for Windows
-
-1. Install pyinstaller
-2. Execute the following command:
-```bash
-pyinstaller --onefile --add-data="./bn_modeller/resources/icon.ico;." --icon=./bn_modeller/resources/icon.ico --name=bn_modeller.exe --windowed ./bn_modeller/app.py
-
-```
-## Instalation
+or can download the latest Windows executable from the [BN Modeller GitHub Releases page](https://github.com/Digiratory/bayes_model/releases).
 
 ### Graphviz
 
-A Graphviz error could arise.
-To solve the problem add the Graphviz executables on your systems' PATH as follows:
+A Graphviz error could arise. To solve the problem add the Graphviz executables on your systems' PATH as follows:
 
-1. Install windows package from: https://graphviz.org/download/ (Linux and Mac instructions can be found here as well)
+1. Install windows package from: <https://graphviz.org/download/> (Linux and Mac instructions can be found here as well)
 2. Install python graphviz package
 3. Press the Windows key
 4. Type in the search box: edit environment variables for your account
@@ -52,7 +37,29 @@ Once have done that, restart your python IDE (if it is open). If this was runnin
 Anaconda Command prompt), restart this prompt as well to make sure the prompt finds the new
 environment variables.
 
-https://pygraphviz.github.io/documentation/stable/install.html
+<https://pygraphviz.github.io/documentation/stable/install.html>
+
+## Launch Application
+
+To launch the application installed with `pip`, run:
+
+```bash
+bn_modeller
+```
+
+If you have downloaded BN Modeller using the Windows executable, simply double-click the `bn_modeller.exe` file located in the directory.
+
+## Build
+
+### Build Executable file for Windows
+
+1. Install pyinstaller
+2. Execute the following command:
+
+```bash
+pyinstaller --onefile --add-data="./bn_modeller/resources/icon.ico;." --icon=./bn_modeller/resources/icon.ico --name=bn_modeller.exe --windowed ./bn_modeller/app.py
+
+```
 
 ## Troubleshooting
 
@@ -63,7 +70,3 @@ This high storage utilization probably caused by WindowsSearch Engine. To mitiga
 1. Press Win to open Start Menu and type in Index.
 2. Click on Indexing Options.
 3. On this next screen, hit Advanced > (Tab) File Types. For extention `.sqlite` select "Index Properties Only".
-
-## bn_visualize
-
-turn off ```plt.show```

docs/_config.yml

@@ -0,0 +1,16 @@
+title: BN Modeller
+description: Application for feature dependency modeling and evaluation.
+show_downloads: false
+remote_theme: "just-the-docs/just-the-docs"
+site:
+  url: https://digiratory.github.io/bayes_model/
+plugins:
+  - jekyll-remote-theme
+defaults:
+  - scope:
+      path: "assets/img"
+    values:
+      image: true
+search_enabled: false
+nav_enabled: true
+heading_anchors: true