Skip to content

Commit 9a29c86

Browse files
TheShadyRainbow4TheShadyRainbow4
committed
Add README for Word to TXT Converter script
Introduces a detailed README file for the PowerShell Word to TXT Converter utility. The documentation covers prerequisites, installation, usage instructions, key features, technology stack, architecture notes, license, and contact information.
1 parent e06819f commit 9a29c86

1 file changed

Lines changed: 95 additions & 0 deletions

File tree

  • PowerShell-Script_Archive/File & Folder Management/Doc to TXT Converter

‎PowerShell-Script_Archive/File & Folder Management/Doc to TXT Converter/README.md‎

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
<a id="readme-top"></a>
2+
3+
<!-- EliteSoftware Co. LOGO -->
4+
5+
<br />
6+
<div align="center">
7+
<!-- <a href="Logo"> -->
8+
<!-- <img src="https://i.postimg.cc/85MDTcrJ/Elite-Software-LOGO-Mocup2.png" alt="Logo" width="256" height="256"> -->
9+
<!-- </a> -->
10+
</div>
11+
12+
<!-- ABOUT THE PROJECT -->
13+
14+
# 💾 About The Project <div align="center">
15+
16+
## Word to TXT Converter
17+
18+
The `Word to TXT Converter` is a simple PowerShell utility with a graphical user interface (GUI) for batch converting Microsoft Word documents (`.doc` and `.docx`) into plain text (`.txt`) files. The script recursively scans a selected source folder and saves the converted text files to a chosen destination folder.
19+
20+
Built by: Zachary Whiteman & Google Gemini Ai.
21+
22+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
23+
24+
<!-- GETTING STARTED -->
25+
26+
# 🔰 Getting Started
27+
This tool leverages your local installation of Microsoft Word to perform conversions.
28+
29+
## 🕰️ Prerequisites
30+
To run this script, you will need:
31+
32+
* **Windows Operating System.**
33+
* **PowerShell 5.1 or newer.**
34+
* **Microsoft Word:** This script requires a local installation of Microsoft Word to be present on your system. It will not work without it.
35+
36+
## 💽 Installation & Execution
37+
1. **Download:** Download the `Doc-Docx to TXT Converter.ps1` script file.
38+
2. **Unblock:** Right-click the file, go to Properties, and click `Unblock` if the file was downloaded from the internet.
39+
3. **Run:** Execute the script from a PowerShell console.
40+
```powershell
41+
".\Doc-Docx to TXT Converter.ps1"
42+
```
43+
44+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
45+
46+
## 🚀 Usage
47+
The application provides a simple interface to guide you through the conversion process.
48+
49+
1. **Select Source Folder:** Click the "Browse..." button in the "Source Folder" section to choose the directory containing the Word documents you want to convert. The script will scan this folder and all its subdirectories.
50+
2. **Select Destination Folder:** Click the "Browse..." button in the "Destination Folder" section to choose where the converted `.txt` files will be saved.
51+
3. **Start Conversion:** Click the **Start Conversion** button to begin the process.
52+
4. **Monitor Progress:** The "Progress Log" window will display real-time updates, showing which files are being converted and whether each conversion was a success or failure.
53+
54+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
55+
56+
## ✨ Key Features
57+
* **Simple GUI:** An easy-to-use interface for selecting source and destination folders.
58+
* **Batch Conversion:** Automatically finds and converts all `.doc` and `.docx` files in the source directory tree.
59+
* **Recursive Scanning:** Scans all subfolders within the selected source directory.
60+
* **Live Progress Log:** Provides real-time feedback on the conversion process.
61+
* **COM Automation:** Utilizes the Microsoft Word application in the background to ensure high-fidelity text extraction.
62+
63+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
64+
65+
## 🛠️ Technology Stack
66+
* **Scripting Language:** PowerShell
67+
* **GUI Framework:** .NET Windows Forms (WinForms).
68+
* **Core Logic:** Interacts with the Microsoft Word COM Object (`Word.Application`) to open and save documents.
69+
70+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
71+
72+
## 📐 Architecture & Security Notes
73+
* **Microsoft Word Dependency:** This script is entirely dependent on a local installation of Microsoft Word. It automates the Word application in the background to perform the conversion.
74+
* **Read-Only on Source:** The script only reads the source documents; it does not modify or delete them.
75+
* **COM Object Usage:** The script creates and releases a `Word.Application` COM object. This is a standard way to automate Microsoft Office applications.
76+
77+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
78+
79+
## 🪪 License
80+
Distributed under the MIT License. See LICENSE.txt for more information.
81+
82+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
83+
84+
## ☎️ Contact
85+
Zach Whiteman - elitesoftwarecolimited@gmail.com
86+
87+
HuggingFace - https://huggingface.co/EliteSoftware
88+
89+
HuggingFace (Personal) - https://huggingface.co/TheShadyRainbow
90+
91+
LinkTree - https://linktr.ee/zachrainbow
92+
93+
Patreon - https://www.patreon.com/c/EliteSoftwareCo
94+
95+
<p align="right">(<a href="#readme-top">back to top</a>)</p>

0 commit comments

Comments
 (0)