docs: addet readme stuff and addet requirements.txt file for easy project initialisation
This commit is contained in:
parent
61a3cb2ff4
commit
339c75cfb1
2 changed files with 21 additions and 1 deletions
18
README.md
18
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
|
||||
|
|
4
requirements.txt
Normal file
4
requirements.txt
Normal file
|
@ -0,0 +1,4 @@
|
|||
flask
|
||||
flask-sqlalchemy
|
||||
flask-login
|
||||
markdown
|
Loading…
Add table
Add a link
Reference in a new issue