Skip to content

Commit f39f426

Browse files
committed
Readme updated
1 parent 4049f79 commit f39f426

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

Markdown-viewer/README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Markdown viewer
2+
Running this Script opens up a markdown viewer where the user can write markdown files (readme files) and see the preview on a button click.
3+
4+
## Setup instructions
5+
In order to run this script, you need to have Python and pip installed on your system. After you're done installing Python and pip, run the following command from your terminal to install the requirements from the same folder (directory) of the project.
6+
```
7+
pip install -r requirements.txt
8+
```
9+
After satisfying all the requirements for the project, Open the terminal in the project folder and run
10+
```
11+
python viewer.py
12+
```
13+
or
14+
```
15+
python3 viewer.py
16+
```
17+
depending upon the python version. Make sure that you are running the command from the same virtual environment in which the required modules are installed.
18+
19+
## Output
20+
21+
The user can enter the markdown data and see the preview as shown in the sample screenshot below
22+
23+
![Markdown Viewer](https://i.postimg.cc/v8jzWNng/markdown-Viewer.png)
24+
25+
## Author
26+
[Ayush Jain](https://github.com/Ayushjain2205)

0 commit comments

Comments
 (0)