From d38028f63e49874d10ef6e4d978d1c3a34344aa1 Mon Sep 17 00:00:00 2001
From: Ralf Klammer <ralf.klammer@tu-dresden.de>
Date: Tue, 20 Feb 2024 15:11:22 +0100
Subject: [PATCH] Refine README.MD
---
README.MD | 68 +++++++++++++++++++++++++++++++++++++++++++++++++++---
config.ini | 3 +++
2 files changed, 68 insertions(+), 3 deletions(-)
diff --git a/README.MD b/README.MD
index 5c28deb..669536f 100644
--- a/README.MD
+++ b/README.MD
@@ -1,8 +1,70 @@
-# TMNG
-This is a very simple flask based python-package.
+# FLASK Dummy
+This is a very simple [FLASK](https://flask.palletsprojects.com/en/3.0.x/) and [click](https://click.palletsprojects.com/en/8.1.x/) based python package.
-## tmng.ini-Example
+It enables you to:
+
+- run a simple web app
+- run command line interface commands
+
+## Install and start
+
+It is recommended to install the package inside a virtual python environment.
+
+This could be initilized and activated in the following way:
+
+```bash
+python3 -m venv venv/ --prompt "$(pwd | grep -o "[^/]*$")"
+. venv/bin/activate
+```
+
+Then simply install the package:
+
+```bash
+pip install -e .
+```
+
+*NOTE:* By adding `-e` to the installation, the package gets installed as an editable package and takes notice of changes!
+
+Now you have set up this basic flask based python package. In the `setup.py` are 2 basic entry points defined:
+
+
+```python
+ entry_points={
+ "console_scripts": [
+ "project_code = project_code.cli:main",
+ "project_app = project_app.app:startup",
+ ]
+ },
+```
+
+This means you are able to:
+
+### start the FLASK UI
+
+```bash
+project_app
```
+
+### run command line interface commands
+
+```bash
+project_code
+```
+
+
+## Configuration
+
+If you want to define configurations, you can save them in a `config.ini`.
+
+Just make sure to have this file in the same directory, where you have started the application from.
+
+This is an example for the currently definable configurations
+
+```INI
+[main]
+port=8083
+
[log]
level=DEBUG
+
```
diff --git a/config.ini b/config.ini
index f047388..6e39924 100644
--- a/config.ini
+++ b/config.ini
@@ -1,2 +1,5 @@
+[main]
+port=8083
+
[log]
level=DEBUG
--
GitLab