Loading repository data…
onelenyk / repository
pdf-project
pdf-project is a Kotlin-based command-line tool designed to convert project files into a comprehensive PDF document. This tool simplifies the process of creating project documentation by transforming code files and related content into a single, well-organized PDF.
Live repository statistics
★ 1Stars
⑂ 0Forks
◯ 0Open issues
◉ 1Watchers
27/100
OPENREPOHUB HEALTH SIGNAL
Limited signals
A transparent discovery signal based on current public GitHub metadata.
Recent activity35% weight
10
Community adoption25% weight
0
Maintenance state20% weight
100
License clarity10% weight
0
Project information10% weight
35
This score does not audit code, security, maintainers, documentation quality, or suitability. Verify the repository and its current documentation before adoption.
README preview
pdf-project
pdf-project is a Kotlin-based command-line tool designed to convert project files into a comprehensive PDF document. This tool simplifies the process of creating project documentation by transforming code files and related content into a single, well-organized PDF.
Features
- Kotlin CLI: Built with Kotlin, ensuring modern language features and robust performance.
- File Conversion: Converts project files to HTML and then compiles them into a single PDF.
- Customizable Rules: Allows custom rules for file filtering.
- Automated Processing: Efficiently processes files and directories.
- Comprehensive Output: Generates a detailed PDF document.
Installation
Installation through install_pdfproject.sh
Follow these steps to install pdfproject using the install_pdfproject.sh script. This method requires only the installation script.
Prerequisites
- Ensure Java is installed on your system.
Steps
-
Download the Installation Script: curl -L -o install_pdfproject.sh "https://raw.githubusercontent.com/onelenyk/pdf-project/master/install_pdfproject.sh"
-
Make the Script Executable: chmod +x install_pdfproject.sh
-
Run the Installation Script: ./install_pdfproject.sh
-
Verify Installation: pdfproject --version
Script Details
The install_pdfproject.sh script downloads the latest JAR file, creates an execution script, and optionally sets up a symbolic link for easy access.
Usage
Run pdfproject --help to see the available options and commands. For further assistance, refer to the project's issues page on GitHub.
Contributions
Contributions are welcome! Please submit a pull request or open an issue for improvements or bug fixes.
Documentation
For more detailed information, please visit our documentation.
Acknowledgements
- onelenyk - Initial work and maintenance.
- ChatGPT by OpenAI - Assisted in development.
License
This project is licensed under the Apache License 2.0.