diff --git a/Readme.md b/Readme.md index 204db68..80ee301 100644 --- a/Readme.md +++ b/Readme.md @@ -31,7 +31,16 @@ You can install the required libraries using pip: ```bash pip install markdown python-docx beautifulsoup4 ``` -## Why repo and not others ? + +To run the sample files follow the below steps: + +```bash +python markdown_to_word_converter.py +Enter the path to the Markdown file (e.g., README.md): ..\sample_files\amazon_case_study.md +Enter the path for the output Word file (e.g., README.docx): ..\sample_files\amazon_case_study.docx +``` + +## Why this repo and not others ? Here are some reasons why this script might be considered better or more suitable for certain use cases compared to other scripts available on the internet: diff --git a/amazon_case_study.docx b/sample_files/amazon_case_study.docx similarity index 94% rename from amazon_case_study.docx rename to sample_files/amazon_case_study.docx index 3208d47..082535f 100644 Binary files a/amazon_case_study.docx and b/sample_files/amazon_case_study.docx differ diff --git a/amazon_case_study.md b/sample_files/amazon_case_study.md similarity index 100% rename from amazon_case_study.md rename to sample_files/amazon_case_study.md diff --git a/markdown_to_word_converter.py b/src/markdown_to_word_converter.py similarity index 100% rename from markdown_to_word_converter.py rename to src/markdown_to_word_converter.py