|
1 | 1 | # CompressKit Documentation |
| 2 | +*"In the labyrinth of digital scrolls, where every byte carries a tale, CompressKit emerges—a keeper of clarity, a guardian of space. Let it weave its magic, shrinking PDFs without silencing their stories."* |
| 3 | + |
| 4 | +--- |
| 5 | + |
| 6 | +## Table of Contents |
| 7 | +- [Overview](#overview) |
| 8 | +- [Installation](#installation) |
| 9 | + - [Prerequisites](#prerequisites) |
| 10 | + - [Install Command](#install-command) |
| 11 | +- [Usage Guide](#usage-guide) |
| 12 | + - [Basic Usage](#basic-usage) |
| 13 | + - [Advanced Options](#advanced-options) |
| 14 | + - [Quality Levels](#quality-levels) |
| 15 | + - [Optimization](#optimization) |
| 16 | + - [Backup Options](#backup-options) |
| 17 | +- [Example Use Cases](#example-use-cases) |
| 18 | +- [Troubleshooting](#troubleshooting) |
| 19 | + - [Common Issues](#common-issues) |
| 20 | +- [Contributing](#contributing) |
| 21 | + - [Steps to Contribute](#steps-to-contribute) |
| 22 | +- [License](#license) |
| 23 | + |
| 24 | +--- |
2 | 25 |
|
3 | 26 | ## Overview |
4 | 27 | CompressKit is an advanced PDF compression toolkit optimized for Termux environments. It provides efficient compression while maintaining document quality and readability. |
5 | 28 |
|
| 29 | +**Key Features:** |
| 30 | +- Efficient PDF compression for Termux environments |
| 31 | +- Multiple quality levels to suit diverse needs |
| 32 | +- Metadata preservation and customizable DPI settings |
| 33 | +- Backup options to safeguard your original files |
| 34 | + |
| 35 | +--- |
| 36 | + |
6 | 37 | ## Installation |
7 | 38 |
|
8 | 39 | ### Prerequisites |
9 | | -- Termux updated to latest version |
| 40 | +- **Termux** updated to the latest version |
10 | 41 | - Required packages: |
11 | | - - ghostscript |
12 | | - - qpdf |
13 | | - - imagemagick |
| 42 | + - `ghostscript` *(for PDF rendering and compression)* |
| 43 | + - `qpdf` *(for advanced PDF manipulation)* |
| 44 | + - `imagemagick` *(for image optimization within PDFs)* |
14 | 45 |
|
15 | 46 | ### Install Command |
| 47 | +Run the following commands in your Termux environment: |
16 | 48 | ```bash |
17 | 49 | pkg install ghostscript qpdf imagemagick |
18 | 50 | chmod +x compresskit-pdf |
19 | | -``` |
20 | | - |
21 | | -## Usage Guide |
22 | | - |
23 | | -### Basic Usage |
24 | | -```bash |
25 | | -compresskit-pdf input.pdf |
26 | | -``` |
27 | | - |
28 | | -### Advanced Options |
29 | | - |
30 | | -#### Quality Levels |
31 | | -- High: `-q high` (minimal compression, best quality) |
32 | | -- Medium: `-q medium` (balanced compression) |
33 | | -- Low: `-q low` (maximum compression) |
34 | | - |
35 | | -#### Optimization |
36 | | -- Aggressive: `-a` or `--aggressive` |
37 | | -- Custom DPI: `-d <value>` or `--dpi <value>` |
38 | | -- Keep Metadata: `-k` or `--keep-metadata` |
39 | | - |
40 | | -#### Backup Options |
41 | | -- Disable Backup: `-n` or `--no-backup` |
42 | | -- Custom Backup Directory: `-b <dir>` or `--backup-dir <dir>` |
43 | | - |
44 | | -## Troubleshooting |
45 | | - |
46 | | -### Common Issues |
47 | | -1. Permission Denied |
48 | | - - Solution: Ensure file permissions are correct |
49 | | - |
50 | | -2. Missing Dependencies |
51 | | - - Solution: Run `pkg install ghostscript qpdf imagemagick` |
52 | | - |
53 | | -3. PDF Corruption |
54 | | - - Solution: Use backup copy from backup directory |
55 | | - |
56 | | -## Contributing |
57 | | -1. Fork the repository |
58 | | -2. Create feature branch |
59 | | -3. Commit changes |
60 | | -4. Push to branch |
61 | | -5. Create Pull Request |
62 | | - |
63 | | -## License |
64 | | -This project is licensed under the MIT License - see the LICENSE file for details. |
0 commit comments