diff --git a/README.md b/README.md new file mode 100644 index 0000000..b2b9ca8 --- /dev/null +++ b/README.md @@ -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 +``` + +## 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.