Skip to content

Commit 465dae2

Browse files
committed
docs: update README.md
1 parent 6c79335 commit 465dae2

File tree

4 files changed

+14
-50
lines changed

4 files changed

+14
-50
lines changed

README.md

Lines changed: 14 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -57,49 +57,13 @@
5757
</a>
5858
</p>
5959
<br>
60-
<hr style="border: 1px dashed #4A6B9A; margin: 20px 0;">
6160

62-
---
61+
<hr style="border: 1px dashed #4A6B9A; margin: 20px 0;">
6362

6463
Welcome to **Text Extractor**, a powerful Python-based desktop application built with PyQt6, designed to extract and consolidate text from multiple files into a single output file. This tool is ideal for students, researchers, developers, and anyone needing to efficiently manage and merge text content from various sources, with advanced features like duplicate removal, customizable output formatting, and a modern, themeable interface.
6564

66-
## Important Notices
67-
68-
### Disclaimer
69-
70-
Text Extractor is a tool designed for personal and educational use only, to assist users in extracting and consolidating text from files they have the legal right to access. The maintainers of this project **do not condone or support the unauthorized use or distribution of copyrighted material**. Users are solely responsible for ensuring they have the legal right to access and process the files they use with this tool, and for complying with all applicable laws and terms of service.
71-
72-
**Misuse of this tool to infringe on intellectual property rights, violate copyright laws, or breach terms of service is strictly prohibited.** The maintainers are not liable for any misuse of Text Extractor or any consequences arising from its use, including but not limited to legal action, financial loss, or damage to third parties.
73-
74-
### Ethical Use Guidelines
75-
76-
Text Extractor processes text files, which may include content from proprietary or copyrighted sources. We strongly encourage users to:
77-
78-
- Use Text Extractor responsibly and only for files you have the legal right to access.
79-
- Respect the intellectual property rights of content creators and owners.
80-
- Avoid redistributing extracted content without permission, as this may violate copyright laws.
81-
82-
### Risks and Limitations
83-
84-
- **Legal Risks**: Processing files with Text Extractor may involve copyrighted material. Users assume all legal risks associated with using this tool.
85-
- **File Compatibility**: While Text Extractor supports a wide range of text-based file formats, some files may not be readable due to encoding issues or proprietary formats.
86-
- **Performance**: Processing large numbers of files or very large files may require significant system resources, depending on the user’s hardware.
87-
88-
## Community Standards
89-
90-
We are committed to fostering a welcoming and respectful community around Text Extractor. Please read our Code of Conduct and Security Policy to understand the standards we expect from all contributors and users. Key points include:
91-
92-
- Respecting the intellectual property rights of content creators.
93-
- Refraining from using Text Extractor to engage in illegal activities, such as unauthorized processing of copyrighted material.
94-
- Reporting any violations of the Code of Conduct or security issues to the maintainers via izeno.contact@gmail.com or by opening a private issue labeled "Code of Conduct Violation" or "Security Violation."
95-
9665
## Table of Contents
9766

98-
- Important Notices
99-
- Disclaimer
100-
- Ethical Use Guidelines
101-
- Risks and Limitations
102-
- Community Standards
10367
- Features
10468
- Supported File Formats
10569
- Installation
@@ -180,9 +144,9 @@ Text Extractor is packaged using Briefcase, making it easy to run or distribute
180144

181145
### Pre-Compiled Binaries
182146

183-
- **Windows**: Download the latest `.exe` (portable) or `.msi` (installer) tagged with \[`W`\] for Windows, from the Releases page. Run the MSI installer or use the portable version for no-setup runs.
184-
- **macOS**: Download the latest universal `.dmg` (x86_64 and Apple Silicon) tagged with \[`M`\] for macOS, from the Releases page. Open the DMG, drag the app to Applications, and launch it.
185-
- **Linux**: Download the latest `.rpm` (for Fedora/Red Hat), `.deb` (for Debian/Ubuntu), or `.pkg.tar.zst` (for Arch/Pacman) tagged with \[`L`\] for Linux, from the Releases page. Run the installer and launch the app.
147+
- **Windows**: Download the latest `.exe` (portable) or `.msi` (installer) tagged with \[`W`\] for Windows, from the [Releases section](https://github.com/VoxDroid/Text-Extractor/releases). Run the MSI installer or use the portable version for no-setup runs.
148+
- **macOS**: Download the latest universal `.dmg` (x86_64 and Apple Silicon) tagged with \[`M`\] for macOS, from the [Releases section](https://github.com/VoxDroid/Text-Extractor/releases). Open the DMG, drag the app to Applications, and launch it.
149+
- **Linux**: Download the latest `.rpm` (for Fedora/Red Hat), `.deb` (for Debian/Ubuntu), or `.pkg.tar.zst` (for Arch/Pacman) tagged with \[`L`\] for Linux, from the [Releases section](https://github.com/VoxDroid/Text-Extractor/releases). Run the installer and launch the app.
186150

187151
## Usage
188152

@@ -225,32 +189,33 @@ Upon launching, you’ll see the main interface featuring three tabs: **Extracto
225189
Here are previews of the main tabs in Text Extractor:
226190

227191
<table style="min-width: 50px">
228-
<colgroup><col style="min-width: 25px"><col style="min-width: 25px"></colgroup><tbody><tr class="border-border"><td colspan="1" rowspan="1"><p dir="ltr"><br><strong>Extractor Tab</strong></p></td><td colspan="1" rowspan="1"><p dir="ltr"><br><strong>Settings Tab</strong></p></td></tr><tr class="border-border"><td colspan="1" rowspan="1"><p dir="ltr"><br><strong>Help Tab</strong></p></td><td colspan="1" rowspan="1"><p></p></td></tr></tbody>
192+
<colgroup><col style="min-width: 25px"><col style="min-width: 25px"></colgroup><tbody><tr class="border-border"><td colspan="1" rowspan="1"><p dir="ltr">
193+
<img src="assets/screenshots/extractor.png" alt="Extractor Tab" width="400"/><br><strong>Extractor Tab</strong></p></td><td colspan="1" rowspan="1"><p dir="ltr"><img src="assets/screenshots/settings.png" alt="Settings Tab" width="400"/><br><strong>Settings Tab</strong></p></td></tr><tr class="border-border"><td colspan="1" rowspan="1"><p dir="ltr"><img src="assets/screenshots/help.png" alt="Help Tab" width="400"/><br><strong>Help Tab</strong></p></td><td colspan="1" rowspan="1"><p></p></td></tr></tbody>
229194
</table>
230195

231196
## Releases
232197

233-
- **Windows**: Pre-compiled `.exe` available in the Releases section.
234-
- **macOS**: Pre-compiled universal `.dmg` (x86_64 and Apple Silicon) available in the Releases section.
235-
- **Linux**: Pre-compiled `.rpm` (for Fedora/Red Hat), `.deb` (for Debian/Ubuntu), or `.pkg.tar.tsz` (for Arch/Pacman) available in the Releases page.
198+
- **Windows**: Pre-compiled `.exe` available in the [Releases section](https://github.com/VoxDroid/Text-Extractor/releases).
199+
- **macOS**: Pre-compiled universal `.dmg` (x86_64 and Apple Silicon) available in the [Releases section](https://github.com/VoxDroid/Text-Extractor/releases).
200+
- **Linux**: Pre-compiled `.rpm` (for Fedora/Red Hat), `.deb` (for Debian/Ubuntu), or `.pkg.tar.tsz` (for Arch/Pacman) available in the [Releases section](https://github.com/VoxDroid/Text-Extractor/releases).
236201
- Check release notes for details on new features, bug fixes, and version updates.
237202
- The Briefcase-built Python source remains the primary method, supporting all platforms with proper setup.
238203

239204
## Support
240205

241-
For ways to get help, report issues, or support the project’s development, please see the Support page.
206+
For ways to get help, report issues, or support the project’s development, please see the [Support](SUPPORT.md) page.
242207

243208
## Contributing
244209

245-
Text Extractor is open-source, and contributions are encouraged! Please read our Contributing Guidelines, Code of Conduct, and Security Policy before submitting issues or pull requests. Use the appropriate issue templates for reporting bugs, suggesting features, or other contributions, and the Pull Request template for code submissions.
210+
Text Extractor is open-source, and contributions are encouraged! Please read our [Contributing Guidelines](CONTRIBUTING.md), [Code of Conduct](CODE_OF_CONDUCT.md), and [Security Policy](SECURITY.md) before submitting issues or pull requests. Use the appropriate issue templates for reporting bugs, suggesting features, or other contributions, and the Pull Request template for code submissions.
246211

247212
## Security
248213

249214
If you discover a security vulnerability, please follow our Security Policy by emailing izeno.contact@gmail.com or using the Security Report issue template for non-sensitive issues.
250215

251216
## License
252217

253-
This project is licensed under the MIT License. Use, modify, and distribute it freely per the license terms.
218+
This project is licensed under the [MIT License](LICENSE). Use, modify, and distribute it freely per the license terms.
254219

255220
## Dependencies
256221

@@ -261,13 +226,12 @@ To build from source, install the following Python packages:
261226
- `packaging` (for version parsing)
262227
- `qtawesome` (for icons)
263228
- `briefcase` (for packaging the app)
264-
- `python-docx` (for .docx file support)
265229

266230
Create a `requirements.txt` file with these dependencies and run `pip install -r requirements.txt`.
267231

268232
---
269233

270-
**Developed by VoxDroid**\
271-
GitHub | Ko-fi
234+
**Developed by VoxDroid**
235+
[GitHub](https://github.com/VoxDroid) | [Ko-fi](https://ko-fi.com/izeno)
272236

273237
---

assets/screenshots/extractor.png

18.6 KB
Loading

assets/screenshots/help.png

41.2 KB
Loading

assets/screenshots/settings.png

18.6 KB
Loading

0 commit comments

Comments
 (0)