Merge pull request #5 from shloktech/dev

documentation enhancements and restructuring
shloktech · Aug 11, 2024 · 3588e79 · 3588e79
2 parents 278dad4 + 37f1cd2
commit 3588e79
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 1 deletion.
diff --git 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 → sample_files/amazon_case_study.docx b/amazon_case_study.docx → sample_files/amazon_case_study.docx
diff --git a/amazon_case_study.md → sample_files/amazon_case_study.md b/amazon_case_study.md → sample_files/amazon_case_study.md
diff --git a/markdown_to_word_converter.py → src/markdown_to_word_converter.py b/markdown_to_word_converter.py → src/markdown_to_word_converter.py