3.5 KiB
Building PlantUML
Thank you for your interest in contributing to PlantUML! This guide will help you build the PlantUML project.
PlantUML can be built using either Gradle or Ant. It's recommended to use Gradle as the primary build tool for this project. You will find instructions for both methods, starting with Gradle.
Building PlantUML with Gradle
Prerequisites
Ensure that you have the following installed on your system:
- Java Development Kit (JDK) - version 8 or newer
- Gradle - version 7.0 or newer
- Git - to clone the repository and manage the version control
Getting the Source Code
Clone the PlantUML repository to your local system. You can clone the repository by running the following command in your terminal or command prompt:
git clone https://github.com/plantuml/plantuml.git
Navigate to the project root directory:
cd plantuml
Building the Project
To build the project, run the following command from the project root directory:
gradle build
This command will build the project and create the necessary output files in the build directory.
Running Tests
To run the tests included with the project, use the following command:
gradle test
Creating a JAR File
To create a JAR file of the PlantUML project, run the following command:
gradle jar
The JAR file will be created in the build/libs directory.
Contributing
After successfully building the project, you are ready to start contributing to PlantUML! If you have any changes to contribute, please submit a pull request through the PlantUML GitHub repository.
Additional Resources
Getting Help
If you encounter any issues while building the project, feel free to ask for help on the PlantUML Community Forum or open an issue on the GitHub repository.
Thank you for contributing to PlantUML!
Building PlantUML with Ant (Alternative Method)
For those who prefer using Ant, or only have access to Ant, we provide a build.xml Ant build script as a fallback option to build PlantUML.
Prerequisites
Ensure that you have the following installed on your system:
- Java Development Kit (JDK) - version 8 or newer
- Apache Ant - to run the build script
- Git - to clone the repository and manage the version control
Getting the Source Code
Clone the PlantUML repository to your local system. You can clone the repository by running the following command in your terminal or command prompt:
git clone https://github.com/plantuml/plantuml.git
Navigate to the directory containing the build.xml:
cd plantuml
Building the Project
To build the project using Ant, run the following command:
ant
If you have Ant set up correctly and the prerequisites are met, the build process should start, and the project will be built based on the instructions in the build.xml.