Merge pull request #18 from DHI/DocRefine

Doc refinement

.github/workflows/docs.yml

@@ -0,0 +1,30 @@
+name: Documentation
+
+on:
+  push:
+    branches:    
+      - main
+
+jobs:
+  build:
+
+    runs-on: windows-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python 3.8
+      uses: actions/setup-python@v4
+      with:
+        python-version: "3.8"
+
+    - name: Install mikeplus
+      run: pip install .[dev]
+
+    - name: MkDocs
+      run: mkdocs build
+
+    - name: Deploy to GitHub Pages
+      uses: peaceiris/actions-gh-pages@v3
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: site

docs/index.md

@@ -1,9 +1,40 @@
-# mikeplus Documentation
+![logo](https://raw.githubusercontent.com/DHI/mikepluspy/main/images/logo/mikeplus-py.svg)
+# MIKE+Py: automate your workflows.
 
-## Install
-```
-pip install mikeplus
-```
+MIKE+Py is a python interface for MIKE+. Its main features include:
+* Modifying the MIKE+ database in a way that is consistent with the GUI.
+* Run different kinds of simulations (e.g. MIKE 1D, EPANET, SWMM)
+* Access certain GUI tools pythonically (e.g. import/export tool).
+
+> [!CAUTION]
+> MIKE+Py is experimental and under development.
+> * Be aware that there may be bugs or unexpected behavior - use with caution.
+> * Always make copies of your MIKE+ databases and verify the outcome of scripts.
+> * If you encounter any issues or have any feedback, please report them on [GitHub Issues](https://github.com/DHI/mikepluspy/issues).
+
+## Requirements
+* MIKE+ 2024 (or greater) with valid license
+* Python x64 3.8 to 3.12
+* Windows operating system
+
+## Installation
+
+The version of MIKE+Py you install must match the version of MIKE+ installed on your desktop. 
+
+> [!NOTE]
+> MIKE+Py is not yet available on PyPI since it is in the initial development stages.
+
+| MIKE+ Version | Install command|
+|:--------------|:---------------|
+| MIKE+ 2024    | `pip install https://github.com/DHI/mikepluspy/archive/refs/tags/v2024.0-latest.zip` |
+
+
+## Examples
+Please check out the jupyter notebooks here: https://github.com/DHI/mikepluspy/tree/main/notebooks
+
+## Where can I get help?
+* General help, new ideas and feature requests - [GitHub Discussions](http://github.com/DHI/mikepluspy/discussions) 
+* Bugs - [GitHub Issues](https://github.com/DHI/mikepluspy/issues) 
 
 
 ## Getting started