From 339c75cfb122ae76ccaa96ce6a7949474fc43a5a Mon Sep 17 00:00:00 2001 From: piecka Date: Fri, 21 Mar 2025 11:27:37 +0100 Subject: [PATCH] docs: addet readme stuff and addet requirements.txt file for easy project initialisation --- README.md | 18 +++++++++++++++++- requirements.txt | 4 ++++ 2 files changed, 21 insertions(+), 1 deletion(-) create mode 100644 requirements.txt diff --git a/README.md b/README.md index 3f1b8a4..2fc9adf 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,27 @@ ## flask markdownViewer +### running the project + +##### **Dependencies** + +- python3 + +```bash +git clone https://git.k4li.de/pika/markdownViewer.git && cd markdownViewer + +pip install -r requirements.txt + +python3 run.py +``` + +> Just clone the repo, install the dependencies by the requirements.txt file and run the webapp! + ### features - **Upload your markdown files and display them in a styled way** - **Host links or files for display purposes** -#### todo +## todo - **Login**: Make it, so that you can only add new things when logged in - **Update**: Update current markdown files to display new content diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..0e8223b --- /dev/null +++ b/requirements.txt @@ -0,0 +1,4 @@ +flask +flask-sqlalchemy +flask-login +markdown