Create README.md

This commit is contained in:
Eric David Smith
2023-07-08 14:55:42 -04:00
parent db60e9204b
commit cd046c9f5d

33
README.md Normal file
View File

@@ -0,0 +1,33 @@
# Wikipedia To Markdown
This is a simple script to convert a Wikipedia article to Markdown.
## Prerequisites
- Python 3
## Installation
```bash
git clone
cd wikipedia-markdown-generator
pip3 install -r requirements.txt
```
## Usage
```bash
python3 wiki-to-md.py <topic_name>
```
## Output
The output is a Markdown file with the same name as the topic name in your current directory.
## Why?
I wanted to convert some Wikipedia articles to Markdown for my personal notes. I couldn't find a simple script to do this, so I wrote one myself.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.